diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle index 35a3c39..b9b5ed2 100644 Binary files a/.doctrees/environment.pickle and b/.doctrees/environment.pickle differ diff --git a/.doctrees/usage/installation.doctree b/.doctrees/usage/installation.doctree index 9d38d43..09d1887 100644 Binary files a/.doctrees/usage/installation.doctree and b/.doctrees/usage/installation.doctree differ diff --git a/_sources/usage/installation.rst.txt b/_sources/usage/installation.rst.txt index d596247..469b7ad 100644 --- a/_sources/usage/installation.rst.txt +++ b/_sources/usage/installation.rst.txt @@ -5,7 +5,7 @@ Using ``pip`` ------------- The latest release version of propkatraj can be installed using *pip* and -requires a Python version of 3.8 or later. +requires a Python version of 3.10 or later. .. code:: bash @@ -33,14 +33,14 @@ installed with either ``pip`` or ``conda``. .. code:: bash - // with pip + # with pip pip install MDAnalysisTests pytest - // with conda + # with conda conda install MDAnalysisTests pytest To run the tests, in the source root: .. code:: bash - pytest -v propkatraj/tests \ No newline at end of file + pytest -v propkatraj/tests diff --git a/searchindex.js b/searchindex.js index d210906..428d81c 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"API Documentation": [[0, null]], "Example usage": [[2, null]], "From source": [[3, "from-source"]], "Installation": [[3, null]], "Tests": [[3, "tests"]], "Using pip": [[3, "using-pip"]], "pKa estimates from a molecular dynamics trajectory": [[2, "pka-estimates-from-a-molecular-dynamics-trajectory"]], "propkatraj: ensemble pKa estimates": [[1, null]]}, "docnames": ["api", "index", "usage/examples", "usage/installation"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["api.rst", "index.rst", "usage/examples.rst", "usage/installation.rst"], "indexentries": {"failed_frames_log (propkatraj.propkatraj.results attribute)": [[0, "propkatraj.PropkaTraj.results.failed_frames_log", false]], "failed_times (propkatraj.propkatraj.results attribute)": [[0, "propkatraj.PropkaTraj.results.failed_times", false]], "num_failed_frames (propkatraj.propkatraj.results attribute)": [[0, "propkatraj.PropkaTraj.results.num_failed_frames", false]], "pkas (propkatraj.propkatraj.results attribute)": [[0, "propkatraj.PropkaTraj.results.pkas", false]], "propkatraj (class in propkatraj)": [[0, "propkatraj.PropkaTraj", false]], "times (propkatraj.propkatraj attribute)": [[0, "propkatraj.PropkaTraj.times", false]]}, "objects": {"propkatraj": [[0, 0, 1, "", "PropkaTraj"]], "propkatraj.PropkaTraj": [[0, 1, 1, "", "times"]], "propkatraj.PropkaTraj.results": [[0, 1, 1, "", "failed_frames_log"], [0, 1, 1, "", "failed_times"], [0, 1, 1, "", "num_failed_frames"], [0, 1, 1, "", "pkas"]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "attribute", "Python attribute"]}, "objtypes": {"0": "py:class", "1": "py:attribute"}, "terms": {"": [0, 2], "0": 1, "1": [1, 2], "13": 1, "2": 1, "2024": 1, "214": 2, "24": 0, "28": 2, "3": 3, "3341": 2, "8": [2, 3], "A": 0, "For": 2, "If": [0, 3], "It": 1, "The": [1, 2, 3], "These": [0, 2, 3], "To": 3, "across": 1, "add_subplot": 2, "addit": 3, "adenyl": 2, "after": 3, "all": 2, "also": 3, "an": [1, 2], "analysi": [0, 1, 2], "analyz": 0, "ani": 0, "approach": 1, "ar": [0, 2], "assum": 2, "atom": [0, 2], "atomgroup": 0, "automat": 0, "avail": 0, "ax": 2, "base": 3, "becksteinlab": [0, 3], "behaviour": 0, "bool": 0, "both": 2, "boxplot": 2, "can": [0, 2, 3], "cd": 3, "citat": 1, "class": [0, 1, 2], "clone": 3, "collect": 2, "column": [0, 2], "com": [0, 3], "comput": [0, 1], "conda": 3, "contain": [0, 1, 2], "convert": 0, "core": 0, "current": 0, "data": 2, "datafil": 2, "datafram": [0, 2], "date": 1, "dcd": 2, "default": 0, "detail": 0, "directori": 0, "distribut": 2, "due": 0, "each": 0, "easili": 2, "either": 3, "except": 0, "execut": 2, "expect": 0, "fail": 0, "failed_frames_log": 0, "failed_tim": 0, "fals": 0, "fig": 2, "figsiz": 2, "figur": 2, "file": 0, "final": 0, "finish": 2, "first": 2, "flag": 0, "follow": [0, 2], "found": 2, "frame": [0, 1], "from": 0, "function": 2, "gca": 2, "gener": 2, "git": 3, "github": [0, 1, 3], "gplv2": 1, "group": 0, "ha": 2, "hetatm": 0, "host": 1, "http": [0, 3], "i": [0, 1, 2, 3], "import": 2, "includ": 3, "incorrect": 0, "index": 2, "indic": 0, "inform": 2, "input": 0, "instal": 2, "instanc": 2, "instead": 0, "int": 0, "interest": 2, "issu": 0, "k_a": 2, "kinas": 2, "known": 0, "kwarg": 0, "later": [1, 3], "latest": 3, "lead": 0, "leav": 0, "licens": 1, "like": 0, "list": 0, "load": 2, "ly": 2, "lysin": 2, "made": 0, "mai": 0, "matplotlib": 2, "mda": 2, "mdanalysi": [0, 1, 2], "mdanalysistest": [2, 3], "method": 2, "modul": 1, "more": 0, "name": [0, 2], "nanosecond": 2, "ndarrai": 0, "need": 0, "non": 0, "note": 0, "now": 0, "np": 0, "num_failed_fram": 0, "number": [0, 2], "oct": 1, "onc": 2, "onli": [0, 2], "origin": 2, "p": 2, "packag": [1, 2, 3], "panda": [0, 2], "paramet": 0, "pass": 0, "path": 2, "pd": 0, "pdb": 0, "pdbwriter": 0, "per": 0, "pip": 2, "pka": 0, "pkatraj": 2, "pleas": 0, "plt": 2, "propka": [0, 1], "propka_input": 0, "propkatraj": [0, 2, 3], "protein": [0, 2], "psf": 2, "pyplot": 2, "pytest": 3, "python": 3, "quiet": 0, "r": 2, "rais": 0, "recommend": [0, 3], "record": 0, "releas": [1, 3], "remov": 0, "requir": [2, 3], "resid": 2, "residu": [0, 2], "resnam": 2, "result": [0, 2], "root": 3, "row": 0, "run": [0, 2, 3], "runtimeerror": 0, "safe": 0, "seaborn": 2, "see": 0, "select": [0, 2], "select_atom": 2, "set": 0, "set_xlabel": 2, "set_ylabel": 2, "show": 2, "singl": 1, "skip": 0, "skip_failur": 0, "sn": 2, "sourc": 0, "store": [0, 2], "str": 0, "string": 0, "structur": 1, "subsect": 0, "successfulli": 0, "supplement": 0, "support": 0, "temporari": 0, "test": 2, "them": 2, "thi": [0, 2, 3], "those": 0, "through": 2, "time": [0, 2], "titrat": 0, "topologi": 2, "trajectori": [0, 1], "true": 0, "type": 0, "u": 2, "undefin": 0, "under": 1, "univers": [0, 2], "updatingatomgroup": 0, "us": [0, 1, 2], "user": 0, "v": 3, "v3": 1, "valu": 0, "version": [1, 3], "visual": 2, "wai": 3, "we": [0, 2], "where": 0, "which": [0, 1, 2], "work": 0, "written": 0}, "titles": ["API Documentation", "propkatraj: ensemble pKa estimates", "Example usage", "Installation"], "titleterms": {"api": 0, "document": 0, "dynam": 2, "ensembl": 1, "estim": [1, 2], "exampl": 2, "from": [2, 3], "instal": 3, "molecular": 2, "pip": 3, "pka": [1, 2], "propkatraj": 1, "sourc": 3, "test": 3, "trajectori": 2, "us": 3, "usag": 2}}) \ No newline at end of file +Search.setIndex({"alltitles": {"API Documentation": [[0, null]], "Example usage": [[2, null]], "From source": [[3, "from-source"]], "Installation": [[3, null]], "Tests": [[3, "tests"]], "Using pip": [[3, "using-pip"]], "pKa estimates from a molecular dynamics trajectory": [[2, "pka-estimates-from-a-molecular-dynamics-trajectory"]], "propkatraj: ensemble pKa estimates": [[1, null]]}, "docnames": ["api", "index", "usage/examples", "usage/installation"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["api.rst", "index.rst", "usage/examples.rst", "usage/installation.rst"], "indexentries": {"failed_frames_log (propkatraj.propkatraj.results attribute)": [[0, "propkatraj.PropkaTraj.results.failed_frames_log", false]], "failed_times (propkatraj.propkatraj.results attribute)": [[0, "propkatraj.PropkaTraj.results.failed_times", false]], "num_failed_frames (propkatraj.propkatraj.results attribute)": [[0, "propkatraj.PropkaTraj.results.num_failed_frames", false]], "pkas (propkatraj.propkatraj.results attribute)": [[0, "propkatraj.PropkaTraj.results.pkas", false]], "propkatraj (class in propkatraj)": [[0, "propkatraj.PropkaTraj", false]], "times (propkatraj.propkatraj attribute)": [[0, "propkatraj.PropkaTraj.times", false]]}, "objects": {"propkatraj": [[0, 0, 1, "", "PropkaTraj"]], "propkatraj.PropkaTraj": [[0, 1, 1, "", "times"]], "propkatraj.PropkaTraj.results": [[0, 1, 1, "", "failed_frames_log"], [0, 1, 1, "", "failed_times"], [0, 1, 1, "", "num_failed_frames"], [0, 1, 1, "", "pkas"]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "attribute", "Python attribute"]}, "objtypes": {"0": "py:class", "1": "py:attribute"}, "terms": {"": [0, 2], "0": 1, "1": [1, 2], "10": 3, "13": 1, "2": 1, "2024": 1, "214": 2, "24": 0, "28": 2, "3": 3, "3341": 2, "8": 2, "A": 0, "For": 2, "If": [0, 3], "It": 1, "The": [1, 2, 3], "These": [0, 2, 3], "To": 3, "across": 1, "add_subplot": 2, "addit": 3, "adenyl": 2, "after": 3, "all": 2, "also": 3, "an": [1, 2], "analysi": [0, 1, 2], "analyz": 0, "ani": 0, "approach": 1, "ar": [0, 2], "assum": 2, "atom": [0, 2], "atomgroup": 0, "automat": 0, "avail": 0, "ax": 2, "base": 3, "becksteinlab": [0, 3], "behaviour": 0, "bool": 0, "both": 2, "boxplot": 2, "can": [0, 2, 3], "cd": 3, "citat": 1, "class": [0, 1, 2], "clone": 3, "collect": 2, "column": [0, 2], "com": [0, 3], "comput": [0, 1], "conda": 3, "contain": [0, 1, 2], "convert": 0, "core": 0, "current": 0, "data": 2, "datafil": 2, "datafram": [0, 2], "date": 1, "dcd": 2, "default": 0, "detail": 0, "directori": 0, "distribut": 2, "due": 0, "each": 0, "easili": 2, "either": 3, "except": 0, "execut": 2, "expect": 0, "fail": 0, "failed_frames_log": 0, "failed_tim": 0, "fals": 0, "fig": 2, "figsiz": 2, "figur": 2, "file": 0, "final": 0, "finish": 2, "first": 2, "flag": 0, "follow": [0, 2], "found": 2, "frame": [0, 1], "from": 0, "function": 2, "gca": 2, "gener": 2, "git": 3, "github": [0, 1, 3], "gplv2": 1, "group": 0, "ha": 2, "hetatm": 0, "host": 1, "http": [0, 3], "i": [0, 1, 2, 3], "import": 2, "includ": 3, "incorrect": 0, "index": 2, "indic": 0, "inform": 2, "input": 0, "instal": 2, "instanc": 2, "instead": 0, "int": 0, "interest": 2, "issu": 0, "k_a": 2, "kinas": 2, "known": 0, "kwarg": 0, "later": [1, 3], "latest": 3, "lead": 0, "leav": 0, "licens": 1, "like": 0, "list": 0, "load": 2, "ly": 2, "lysin": 2, "made": 0, "mai": 0, "matplotlib": 2, "mda": 2, "mdanalysi": [0, 1, 2], "mdanalysistest": [2, 3], "method": 2, "modul": 1, "more": 0, "name": [0, 2], "nanosecond": 2, "ndarrai": 0, "need": 0, "non": 0, "note": 0, "now": 0, "np": 0, "num_failed_fram": 0, "number": [0, 2], "oct": 1, "onc": 2, "onli": [0, 2], "origin": 2, "p": 2, "packag": [1, 2, 3], "panda": [0, 2], "paramet": 0, "pass": 0, "path": 2, "pd": 0, "pdb": 0, "pdbwriter": 0, "per": 0, "pip": 2, "pka": 0, "pkatraj": 2, "pleas": 0, "plt": 2, "propka": [0, 1], "propka_input": 0, "propkatraj": [0, 2, 3], "protein": [0, 2], "psf": 2, "pyplot": 2, "pytest": 3, "python": 3, "quiet": 0, "r": 2, "rais": 0, "recommend": [0, 3], "record": 0, "releas": [1, 3], "remov": 0, "requir": [2, 3], "resid": 2, "residu": [0, 2], "resnam": 2, "result": [0, 2], "root": 3, "row": 0, "run": [0, 2, 3], "runtimeerror": 0, "safe": 0, "seaborn": 2, "see": 0, "select": [0, 2], "select_atom": 2, "set": 0, "set_xlabel": 2, "set_ylabel": 2, "show": 2, "singl": 1, "skip": 0, "skip_failur": 0, "sn": 2, "sourc": 0, "store": [0, 2], "str": 0, "string": 0, "structur": 1, "subsect": 0, "successfulli": 0, "supplement": 0, "support": 0, "temporari": 0, "test": 2, "them": 2, "thi": [0, 2, 3], "those": 0, "through": 2, "time": [0, 2], "titrat": 0, "topologi": 2, "trajectori": [0, 1], "true": 0, "type": 0, "u": 2, "undefin": 0, "under": 1, "univers": [0, 2], "updatingatomgroup": 0, "us": [0, 1, 2], "user": 0, "v": 3, "v3": 1, "valu": 0, "version": [1, 3], "visual": 2, "wai": 3, "we": [0, 2], "where": 0, "which": [0, 1, 2], "work": 0, "written": 0}, "titles": ["API Documentation", "propkatraj: ensemble pKa estimates", "Example usage", "Installation"], "titleterms": {"api": 0, "document": 0, "dynam": 2, "ensembl": 1, "estim": [1, 2], "exampl": 2, "from": [2, 3], "instal": 3, "molecular": 2, "pip": 3, "pka": [1, 2], "propkatraj": 1, "sourc": 3, "test": 3, "trajectori": 2, "us": 3, "usag": 2}}) \ No newline at end of file diff --git a/usage/installation.html b/usage/installation.html index a65d252..c098300 100644 --- a/usage/installation.html +++ b/usage/installation.html @@ -86,7 +86,7 @@

Installation

Using pip

The latest release version of propkatraj can be installed using pip and -requires a Python version of 3.8 or later.

+requires a Python version of 3.10 or later.

pip install propkatraj
 
@@ -105,10 +105,10 @@

TestsAfter installing the base package, running tests require the additional installation of the MDAnalysisTests and pytest packages. These can be installed with either pip or conda.

-
// with pip
+
# with pip
 pip install MDAnalysisTests pytest
 
-// with conda
+# with conda
 conda install MDAnalysisTests pytest