Skip to content

Commit

Permalink
fix install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
wtbarnes committed Nov 3, 2023
1 parent 0552147 commit dfd296f
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 17 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,16 @@ To install the package and the needed dependencies,
```shell
$ git clone https://github.com/rice-solar-physics/pydrad.git
$ cd pydrad
$ pip install -r requirements/requirements.txt
$ python setup.py install
$ pip install .
```

If you'd like to run the tests and confirm that everything is working alright,
```shell
$ pip install -r requirements/requirements-dev.txt
$ pytest
$ pip install -e .[tests]
$ pytest pydrad
```

See the [docs](https://rice-solar-physics.github.io/pydrad/) for more info. Additionally, **you will need access to the HYDRAD source code.**
See the [docs](https://pydrad.readthedocs.io/en/latest) for more info.

## Help
Create an issue if you run into any problems. Submit a PR if you would like to add any functionality.
19 changes: 7 additions & 12 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,11 @@ First, clone the repository,
$ git clone https://github.com/rice-solar-physics/pydrad.git
$ cd pydrad
To install all of the needed dependencies,
To install pydrad and all of the needed dependencies,

.. code:: shell
$ pip install -r requirements/requirements/txt
Finally, install the pydrad package,

.. code:: shell
$ python setup.py install
$ pip install .
Testing
-------
Expand All @@ -31,21 +25,22 @@ development dependencies,

.. code:: shell
$ pip install -r requirements/requirements-dev.txt
$ pip install -e .[tests,docs]
and run the tests,

.. code:: shell
$ pytest
$ pytest pydrad
If you’d like to also run the tests that require a local copy of HYDRAD,
If you would like to run the tests using a local copy of HYDRAD,

.. code:: shell
$ pytest --hydrad-dir=/path/to/hydrad
Note that this step is not necessary to run the code.
If you do not specify a path to a particular version of HYDRAD, it will be automatically downloaded from GitHub in order to run the tests.
Note that running the tests is not necessary if you just want to use pydrad.

Additional Resources
--------------------
Expand Down

0 comments on commit dfd296f

Please sign in to comment.