Skip to content

Commit

Permalink
Merge pull request #7 from gkwt/main
Browse files Browse the repository at this point in the history
Update notebook in documentation, and installation instructions
  • Loading branch information
gkwt authored Nov 28, 2024
2 parents de93c91 + 7645b1e commit cecf394
Show file tree
Hide file tree
Showing 4 changed files with 925 additions and 13 deletions.
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ m2r2
nbsphinx
sphinx_design
furo
lxml-html-clean
915 changes: 914 additions & 1 deletion docs/source/examples/notebooks/single_obj.ipynb

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Welcome to Atlas' documentation!

.. image:: _static/atlas_logo.png

**Atlas** is ...::
**Atlas** is an chemistry and materials science adaptive experimentation package. ::

from olympus import Surface, Campaign
from atlas.planners.gp.planner import GPPlanner
Expand Down
20 changes: 9 additions & 11 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
@@ -1,26 +1,24 @@
Installation
============

We recommend to install **Olympus** with ``pip``::
To install Atlas, we recommend installing from from source ::

pip install olymp
git clone https://github.com/aspuru-guzik-group/atlas.git
cd atlas
pip install -e .
pip install -r requirements.txt

Alternatively, you can install **Olympus** with ``conda``::
Atlas works hand-in-hand with Olympus, which can be installed from source. Specifically, the ``olympus-atlas`` branch for compatibility with Atlas. ::

conda install -c conda-forge olymp

Finally, you can clone the GitHub repo and install it from source::

git clone [email protected]:aspuru-guzik-group/olympus.git
git clone olympus-atlas --single-branch https://github.com/aspuru-guzik-group/olympus.git
cd olympus
python setup.py install

python install -e .

Dependencies
------------
The installation only requires:

* ``python >= 3.6``
* ``python >= 3.9``
* ``numpy``
* ``pandas``

Expand Down

0 comments on commit cecf394

Please sign in to comment.