Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
searscr committed Feb 19, 2024
1 parent 1a7b4bd commit f8015e6
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
36 changes: 36 additions & 0 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
Getting Started
===============

.. _getting_started:



Instructions for GARNET development
-----------------------------------

Conda Configuration
```````````````````
Create and activate conda environment for ``GARNET``.

.. code-block:: sh
conda env create --file environment.yml
# or
mamba env create --file environment.yml
conda activate garnet
Install ``GARNET`` (in `editable mode <https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-e>`_) and start application

.. code-block:: sh
python -m pip install -e .
garnet
If it has been a while, once can update using

.. code-block:: sh
conda activate garnet
conda env update --file environment.yml --prune
3 changes: 3 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ license = { text = "GPL-3.0" }
[project.urls]
homepage = "https://github.com/neutrons/garnet/"

[project.scripts]
garnet = "garnet.__main__:main"

[build-system]
requires = ["setuptools", "wheel", "toml", "versioningit"]
build-backend = "setuptools.build_meta"
Expand Down

0 comments on commit f8015e6

Please sign in to comment.