Skip to content

Commit 6e726ca

Browse files
committed
Remove Sandia-specific installation information.
1 parent 243f41c commit 6e726ca

File tree

1 file changed

+1
-37
lines changed

1 file changed

+1
-37
lines changed

docs/source/usage.rst

Lines changed: 1 addition & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -6,44 +6,8 @@ Usage
66
Installation
77
------------
88

9-
To use SDynPy, first download it from the
10-
`CEE-GitLab page <https://cee-gitlab.sandia.gov/dprohe/structural-dynamics-python-libraries>`_.
11-
Once downloaded, you can install it by using :code:`pip`.
12-
13-
.. code-block:: console
14-
15-
$ cd <download_directory_containing_setup.py>
16-
$ pip install .
17-
18-
19-
To install the package and the testing dependencies all at once via `pip` one can run
20-
21-
::
22-
23-
python3 -m pip install .[testing] -i https://nexus.web.sandia.gov/repository/pypi-group/simple
24-
25-
This will install the package as well as the dependencies required for testing. The test-suite can then be run via
26-
27-
::
28-
29-
pytest -m "not unwritten" tests/ --cov=src/sdynpy
30-
31-
Conda Install
32-
~~~~~~~~~~~~~
33-
34-
After cloning the repo, you can setup a computational environment on your Linux blade with all the required dependencies for SDynPy by running the setup shell script::
35-
36-
source setup_SDynPy.sh
37-
38-
This will load the latest Anaconda3 module, and install the various dependencies from the conda/pip sources on the Nexus Sandia server.
9+
Forthcoming...
3910

40-
.. note::
41-
If not on your blade, you can still use the shell script (on Linux), but you will want to comment out the line `module load apps/anaconda3-2022.05`. If you are working on a Windows OS, then you will want to open up a Conda terminal and simply run the conda commands referenced in the shell script.
42-
43-
.. note::
44-
45-
If you utilized the `setup_SDynPy.sh` script, then the testing dependencies should also have been installed, so you can just execute the test commands as described above.
46-
4711
SDynPy Overview
4812
---------------
4913

0 commit comments

Comments
 (0)