Skip to content

Commit

Permalink
Add basic install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
golmschenk committed Feb 23, 2024
1 parent 10ec6d1 commit ef0bc33
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,35 @@
Welcome to eesunhong's documentation!
=====================================

Installation
------------

To install ``eesunhong`` use

.. code:: shell
pip install eesunhong
Although not required, as is generally good practice for any development project, we highly recommend creating a separate virtual environment for each distinct project. For example, via Conda, creating a virtual environment for a project using ``eesunhong`` might look like

.. code::
conda create -n eesunhong_env python=3.11
Then before working, be sure to activate your environment with

.. code:: shell
conda activate eesunhong_env
Then install ``eesunhong`` within this environment.

.. toctree::
:maxdepth: 2
:caption: Contents:

guides/guide_for_fortran_developers



Indices and tables
Expand Down

0 comments on commit ef0bc33

Please sign in to comment.