-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #7 from gkwt/main
Update notebook in documentation, and installation instructions
- Loading branch information
Showing
4 changed files
with
925 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,3 +5,4 @@ m2r2 | |
nbsphinx | ||
sphinx_design | ||
furo | ||
lxml-html-clean |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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`` | ||
|
||
|