Skip to content

Commit ea91731

Browse files
committed
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.
1 parent 9350d57 commit ea91731

3 files changed

Lines changed: 17 additions & 27 deletions

File tree

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
22
[![PyPI version](https://img.shields.io/pypi/v/atomworks.svg)](https://pypi.org/project/atomworks/)
33
[![Python versions](https://img.shields.io/pypi/pyversions/atomworks.svg)](https://pypi.org/project/atomworks/)
4-
[![Documentation Status](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://baker-laboratory.github.io/atomworks-dev/latest/index.html)
4+
[![Documentation Status](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://rosettacommons.github.io/atomworks/latest/)
55
[![License: BSD 3-Clause](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
66

77
<div align="center">
@@ -78,7 +78,8 @@ We have found that `atomworks.ml` **dramatically** reduces the overhead of start
7878
pip install atomworks # base installation version without torch (for only atomworks.io)
7979
pip install "atomworks[ml]" # with torch and ML dependencies (for atomworks.io plus atomworks.ml)
8080
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
8283
```
8384
*Running multiple of these installations will just add to the installed dependencies and will not install multiple installations of atomworks.*
8485

@@ -88,7 +89,7 @@ If you are using [uv](https://docs.astral.sh/uv/reference/policies/versioning/)
8889
uv pip install "atomworks[ml,openbabel,dev]"
8990
```
9091

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).
9293

9394
---
9495

@@ -100,7 +101,7 @@ This section contains information for how to get atomworks set up and a quick gu
100101

101102
To parse a pdb file (parse = load, clean, annotate relevant metadata such as entities, molecules, etc) you can use the `parse` function:
102103

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.
104105
105106
```python
106107

@@ -125,7 +126,7 @@ The output of `parse` includes:
125126
- **assemblies** — Built biological assemblies (each are their own `AtomArrayStack`)
126127
- **metadata** — Experimental and source information
127128

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.
129130
See [API reference documentation](https://rosettacommons.github.io/atomworks/latest/io/parser.html) for more information on this method.
130131

131132
If you just want to load a file, you can use the `load_any` function:

docs/contributor_guide.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,11 @@ As you review
4747
Contributing to the documentation
4848
--------------------------------
4949
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:
5151

52-
* Sphinx (``pip install sphinx``)
53-
54-
* Sphinx gallery (``pip install sphinx-gallery``)
55-
56-
* Pydata Sphinx Theme (``pip install pydata-sphinx-theme``)
52+
.. code-block:: bash
5753
54+
uv pip install -r docs/docs_requirements.txt
5855
5956
To build the documentation, navigate to the ``docs`` directory and run:
6057

docs/installation.rst

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,19 @@ This is the easiest way to get started with atomworks.
1414
pip install "atomworks[dev]" # with development dependencies
1515
pip install "atomworks[ml,dev]" # with all dependencies
1616
17+
You can also install AtomWorks with `Open Babel <https://openbabel.org/>`_, an alternative to RDKit:
1718

18-
2. Using the Standalone Apptainer
19-
-----------------------------------------------
20-
This is ideal for dataset parsing and generation in a controlled environment.
19+
.. code-block:: bash
20+
21+
pip install "atomworks[openbabel]"
22+
23+
or for all possible dependencies:
2124

2225
.. code-block:: bash
2326
24-
# Set up IPD-specific environment variables
25-
source ./.ipd/setup.sh
26-
# Use the provided apptainer image
27-
./.ipd/atomworks.sif
27+
pip install "atomworks[ml,openbabel,dev]"
2828
29-
.. _local-conda_environment:
29+
Open Babel is not automatically installed with AtomWorks due to its larger size and additional dependencies, only install it if you plan to use it.
3030

3131
2. Local Conda Environment
3232
--------------------------
@@ -60,11 +60,3 @@ Add `atomworks.io/src` to your apptainer's PYTHONPATH:
6060
.. code-block:: bash
6161
6262
export PYTHONPATH=$PWD/src:$PYTHONPATH
63-
64-
Or, if at IPD:
65-
66-
.. code-block:: bash
67-
68-
source ./.ipd/setup.sh
69-
70-
For new apptainers, see the apptainer.spec file for integration details.

0 commit comments

Comments
 (0)