Skip to content

Commit

Permalink
Update 'getting started' guides for users and devs
Browse files Browse the repository at this point in the history
  • Loading branch information
aknierim committed Oct 24, 2024
1 parent c526bd9 commit ce04474
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 1 deletion.
46 changes: 45 additions & 1 deletion docs/developer-guide/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,48 @@
Getting Started for Developers
******************************

We strongly recommend using the `Miniforge3 conda distribution <https://github.com/conda-forge/miniforge>`_.
We strongly recommend using the `Miniforge3 conda distribution <https://github.com/conda-forge/miniforge>`_
that ships the package installer ``mamba``, a C++ reimplementation of ``conda``.

.. warning::

The following guide is used only if you want to *develop* the
``radiotools`` package, if you just want to write code that uses it
as a dependency, you can install ``radiotools`` using pip.
See :ref:`getting_started_users`


Setting Up the Development Environment
======================================

We provide a conda environment with all packages needed for development of radiotools
that can be installed via:

.. code-block:: console
$ mamba env create -f environment.yml
Next, switch to this new virtual environment:

.. code-block:: console
$ mamba activate radiotools-dev
You will need to run that last command any time you open a new
terminal session to activate the conda environment.


Installing radiotools in Development Mode
=========================================

To install radiotools inside the ``radiotools-dev`` environment
(or any environment for that matter), just run

.. code-block:: console
$ pip install -e .
This installs the package in editable mode, meaning that you won't have to rerun
the installation for code changes to take effect. For greater changes such as
adding new entry points, the command may have to be run again.
18 changes: 18 additions & 0 deletions docs/user-guide/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,21 @@ Getting Started for Users

The following guide is for *users*. If you want to contribute to
radiotools as a developer, see :ref:`getting_started_dev`.


Installation
============

Currently, radiotools is only available via the
`source repository <https://github.com/radionets-project/radiotools>`_.

To install ``radiotools`` into an existing (conda) environment, use

.. code-block:: console
$ pip install .
in the root directory of the source repository.

To be able to access features provided by the `CASAtools package <https://pypi.org/project/casatools/>`_
make sure you are on python version ``3.10`` or ``3.11``.

0 comments on commit ce04474

Please sign in to comment.