Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update installation instructions #154

Merged
merged 36 commits into from
Jan 10, 2022
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
dcfaf1b
add dependency missing from pip version of xdesign
smajee Dec 29, 2021
e9ff99e
update example command for GPU install
smajee Dec 29, 2021
ad6bb4d
add dev requirements
smajee Dec 29, 2021
4ba2057
fix bug in link
smajee Dec 29, 2021
f8d072e
fix incorrect instruction for astra
smajee Dec 30, 2021
bbca395
Doc fix
smajee Dec 30, 2021
289dd38
move docs building instructions from install to contributing
smajee Jan 4, 2022
462af6d
Update astra install channel
smajee Jan 4, 2022
21e0f41
add dependency installation in examples
smajee Jan 4, 2022
3c4e867
fix link
smajee Jan 4, 2022
06f7b2c
add example dependencies heading
smajee Jan 4, 2022
393c5a1
add ref
smajee Jan 4, 2022
d4be3b7
add new ref
smajee Jan 4, 2022
ec83acc
update links
smajee Jan 4, 2022
4103091
clean up links
smajee Jan 4, 2022
0dde201
clean up extra instructions
smajee Jan 4, 2022
b5a83bb
Merge main into branch
smajee Jan 4, 2022
03c9a0c
Merge branch 'main' into smajee/install_instructions
bwohlberg Jan 6, 2022
36beca9
Fix wording
smajee Jan 6, 2022
4711b17
Merge branch 'smajee/install_instructions' of github.com:lanl/scico i…
smajee Jan 6, 2022
b4f0cd3
fix indentation:
smajee Jan 6, 2022
e278182
revert
smajee Jan 6, 2022
3805e4e
remove doc duplication
smajee Jan 6, 2022
4bc20c4
misc changes
smajee Jan 6, 2022
34ff9ac
add indent
smajee Jan 6, 2022
c9ed61a
fix typo
smajee Jan 6, 2022
cbf811b
change wording
smajee Jan 6, 2022
6a6b725
fix wording
smajee Jan 6, 2022
1ec4614
change wording
smajee Jan 6, 2022
528c043
Merge branch 'main' into smajee/install_instructions
bwohlberg Jan 6, 2022
93694fb
Update examples.rst
bwohlberg Jan 6, 2022
75b666d
fix bug
smajee Jan 7, 2022
ce4da27
Merge branch 'smajee/install_instructions' of github.com:lanl/scico i…
smajee Jan 7, 2022
617e993
add comment about neccessity of installing example requirements
smajee Jan 7, 2022
d2301b7
update submodule
smajee Jan 7, 2022
7d37a01
merge main
smajee Jan 7, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 10 additions & 14 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Installing a Development Version
conda activate scico


6. Navigate to the root of the cloned repository:
6. Change directory to the root of the cloned repository:

::

Expand Down Expand Up @@ -107,28 +107,24 @@ Installing a Development Version
Building Documentation
----------------------

A local copy of the documentation can be built from the respository root directory by doing
Before building the documentation, one must install the documentation specific dependencies by running

::

python setup.py build_sphinx

pip install -r docs_requirements.txt

Alternatively:
Then, a local copy of the documentation can be built from the respository root directory by running

1. Navigate to the docs directory ``docs/``

2. Install dependencies
::

::
python setup.py build_sphinx

pip install -r docs_requirements.txt

3. Build documentation
Alternatively, one can also build the documentation by running the following from the `docs/`` directory

::
::

make html
make html



Expand Down Expand Up @@ -223,7 +219,7 @@ scico-data repositories must be updated and kept in sync.

1. Add the ``new_data.npz`` file to the ``scico/data`` directory.

2. Navigate to the ``data`` directory and add/commit the new data file:
2. Change directory to the ``data`` directory and add/commit the new data file:

::

Expand Down
9 changes: 5 additions & 4 deletions docs/source/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,19 @@ Usage Examples
:maxdepth: 1

.. _example_dependencies:

Example Dependencies
------------------------
--------------------

Some examples may use additional dependecies. These dependencies are listed in `examples_requirements.txt <https://github.com/lanl/scico/blob/main/examples/examples_requirements.txt>`_.
Pip should be used to install these extra requirements except astra which should be installed via conda:
Some examples use additional dependencies which are listed in `examples_requirements.txt <https://github.com/lanl/scico/blob/main/examples/examples_requirements.txt>`_.
bwohlberg marked this conversation as resolved.
Show resolved Hide resolved
The additional requirements should be installed via pip, with the exception of astra-toolbox, which should be installed via conda:
bwohlberg marked this conversation as resolved.
Show resolved Hide resolved

::

conda install -c astra-toolbox astra-toolbox
pip install -r examples/examples_requirements.txt # Installs other example requirements

The dependencies can also be installed one by one as required.
The dependencies can also be installed individually as required.

Organized by Application
------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The instructions above install a CPU-only version of SCICO. To install a version
Additional Dependencies
-----------------------

For installing dependencies related to the examples please see :ref:`example_notebooks`.
For instructions on installing dependencies related to the examples please see :ref:`example_notebooks`.


For Developers
Expand Down