Skip to content

Commit

Permalink
tested local install
Browse files Browse the repository at this point in the history
  • Loading branch information
timothyas committed Oct 27, 2023
1 parent 808be2d commit 024f626
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 12 deletions.
28 changes: 20 additions & 8 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,18 @@ and install it as follows::

git clone https://github.com/timothyas/xesn.git
cd xesn
python setup.py install
pip install -e .

or alternatively via pip::
Note that additional dependencies can be installed to run the unit test suite,::

pip install -e .[test]
pytest xesn/test/*.py

or to install `cupy <https://cupy.dev/>`_ to run on GPUs::

pip install -e .[gpus]

Alternatively, the package can be installed via pip::

pip install git+https://github.com/timothyas/xesn.git

Expand All @@ -22,12 +31,15 @@ the project and submit
and
`pull requests <https://github.com/timothyas/xesn/pulls>`_.

Running the Example Notebooks
=============================
Running Example Notebooks or Building the Documentation Locally
===============================================================

Due to the way pandoc is installed via pip `as detailed here
<https://stackoverflow.com/a/71585691>`_
it is recommended to create an environment with conda in order to build the
documentation locally.
This is also recommended for running any of the example notebooks locally, since
there are a couple of additional dependencies required::

To run the example notebooks shown in this documentation, please first install a
few additional dependencies::
conda env create -f docs/environment.yaml
conda activate xesn

5 changes: 1 addition & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,13 @@ license = {file = "LICENSE.txt"}
readme = "README.md"
requires-python = ">=3.9"
dependencies = [
"numpy", "scipy", "xarray", "dask[complete]", "zarr", "smt>=2.0.1",
"numpy", "scipy", "xarray", "dask[complete]", "zarr", "smt>=2.0.1", "matplotlib"
]

[project.optional-dependencies]
test = [
"pytest", "coverage",
]
docs = [
"sphinx", "sphinx_rtd_theme", "nbsphinx"
]
gpus = [
"cupy"
]
Expand Down

0 comments on commit 024f626

Please sign in to comment.