Skip to content

Commit

Permalink
Merge pull request #276 from DavidT3/docs/updateInstallInstructions
Browse files Browse the repository at this point in the history
Docs/update install instructions
  • Loading branch information
DavidT3 committed Apr 25, 2024
2 parents a85a85b + 4945097 commit 64c3570
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 7 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,37 @@ Documentation is available on ReadTheDocs, and [can be found here](https://daxa.
accessed by clicking on the documentation build status at the top of the README. The source for the documentation can
be found in the 'docs' directory in this repository.

# Installing DAXA

We **strongly recommend** that you make use of Python virtual environments, or (even better) Conda/Mamba virtual environments when installing DAXA.

DAXA is available on the popular Python Package Index (PyPI), and can be installed like this:

```
pip install daxa
```

You can also fetch the current working version from the git repository, and install it (this method has replaced 'python setup.py install'):

```
git clone https://github.com/DavidT3/DAXA
cd DAXA
python -m pip install .
```

Alternatively you could use the 'editable' option (this has replaced running setup.py and passing 'develop') so that any changes you pull from the remote repository are reflected without having to reinstall DAXA.

```
git clone https://github.com/DavidT3/DAXA
cd DAXA
python -m pip install --editable .
```

# Which missions are supported?

**_DAXA is still in an early stage of development, and as such the list of supported telescopes is currently
limited. Support for more telescopes is either currently under development or being actively planned._**
_DAXA is still in a relatively early stage of development, and as such the support for local re-processing is
limited; however, support for the acquisition and use of pre-processed data is implemented for a wide selection
of telescopes:_

* XMM-Newton Pointed
* eROSITA Commissioning
Expand Down
14 changes: 9 additions & 5 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
Installing and Configuring DAXA
==============

This is a slightly more complex installation than many Python modules, but shouldn't be too difficult. If you're
having issues feel free to contact me.
This can be a slightly more complex installation than many Python modules, but shouldn't be too difficult. If you're
having issues feel free to contact us.

The Module
----------

**DAXA is not yet available on PyPi or Conda, though it will be in the future**
We **strongly recommend** that you make use of Python virtual environments, or (even better) Conda/Mamba virtual environments when installing DAXA.

I strongly recommend that you make use of Python virtual environments, or (even better) Conda/Mamba virtual environments when installing DAXA.
DAXA is available on the popular Python Package Index (PyPI), and can be installed like this:

You can fetch the current working version from the git repository, and install it (this method has replaced 'python setup.py install'):
.. code-block::
pip install daxa
You can also fetch the current working version from the git repository, and install it (this method has replaced 'python setup.py install'):

.. code-block::
Expand Down

0 comments on commit 64c3570

Please sign in to comment.