You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update documentation links and installation instructions
Updated documentation URLs to point to rosettacommons.github.io instead of baker-laboratory.github.io. Clarified installation instructions for Open Babel and updated contributor guide to use a requirements file for documentation dependencies. Removed outdated Apptainer instructions and improved clarity in installation steps.
@@ -78,7 +78,8 @@ We have found that `atomworks.ml` **dramatically** reduces the overhead of start
78
78
pip install atomworks # base installation version without torch (for only atomworks.io)
79
79
pip install "atomworks[ml]"# with torch and ML dependencies (for atomworks.io plus atomworks.ml)
80
80
pip install "atomworks[dev]"# with development dependencies
81
-
pip install "atomworks[ml,dev]"# with all dependencies
81
+
pip install "atomworks[openbabel]"# with [Open Babel](https://openbabel.org/) and its dependencies
82
+
pip install "atomworks[ml,openbabel,dev]"# with all dependencies
82
83
```
83
84
*Running multiple of these installations will just add to the installed dependencies and will not install multiple installations of atomworks.*
84
85
@@ -88,7 +89,7 @@ If you are using [uv](https://docs.astral.sh/uv/reference/policies/versioning/)
88
89
uv pip install "atomworks[ml,openbabel,dev]"
89
90
```
90
91
91
-
For more advanced setup options (including how to run workflows via apptainers) see the [full documentation](https://baker-laboratory.github.io/atomworks-dev/latest).
92
+
For more advanced setup options (including how to run workflows via apptainers) see the [full documentation](https://rosettacommons.github.io/atomworks/latest/index.html).
92
93
93
94
---
94
95
@@ -100,7 +101,7 @@ This section contains information for how to get atomworks set up and a quick gu
100
101
101
102
To parse a pdb file (parse = load, clean, annotate relevant metadata such as entities, molecules, etc) you can use the `parse` function:
102
103
103
-
> Note: To run the code in this section you will need to download the 3nez.cif.gz file yourself. See the [examples](https://baker-laboratory.github.io/atomworks-dev/latest/auto_examples/) for how to download files from the PDB within a Python script.
104
+
> Note: To run the code in this section you will need to download the 3nez.cif.gz file yourself. See the [examples](https://rosettacommons.github.io/atomworks/latest/auto_examples/index.html) for how to download files from the PDB within a Python script.
104
105
105
106
```python
106
107
@@ -125,7 +126,7 @@ The output of `parse` includes:
125
126
-**assemblies** — Built biological assemblies (each are their own `AtomArrayStack`)
126
127
-**metadata** — Experimental and source information
127
128
128
-
See [usage examples](https://baker-laboratory.github.io/atomworks-dev/latest/auto_examples/) for more examples of the use of `parse()`. All of the provided examples make use of this method.
129
+
See [usage examples](https://rosettacommons.github.io/atomworks/latest/auto_examples/index.html) for more examples of the use of `parse()`. All of the provided examples make use of this method.
129
130
See [API reference documentation](https://rosettacommons.github.io/atomworks/latest/io/parser.html) for more information on this method.
130
131
131
132
If you just want to load a file, you can use the `load_any` function:
Copy file name to clipboardExpand all lines: docs/contributor_guide.rst
+3-6Lines changed: 3 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,14 +47,11 @@ As you review
47
47
Contributing to the documentation
48
48
--------------------------------
49
49
The external AtomWorks documentation is built using `Sphinx <https://www.sphinx-doc.org/en/master/#>`_ and hosted on `GitHub Pages <https://docs.github.com/en/pages>`_.
50
-
Aside from having AtomWorks and its dependencies installed, you will need to have the following installed to build the documentation locally:
50
+
Aside from having AtomWorks and its dependencies installed, to build the documentation locally, you will need to install the documentation requirements:
0 commit comments