Skip to content

Commit

Permalink
Update documents
Browse files Browse the repository at this point in the history
  • Loading branch information
paulf81 committed Feb 26, 2024
1 parent 8b0bd74 commit 8fd75e3
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 4 deletions.
41 changes: 40 additions & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
@@ -1 +1,40 @@
# Installation instructions
# Installation

moa_python is currently not available as a package on any repository manager.
Instead, it must be installed by the user by cloning the GitHub repository.

To download the source code, use `git clone`. Then, add it to
your Python path with the "local editable install" through `pip`.

```bash
# Download the source code.
git clone https://github.com/NREL/moa_python.git

# Install into your Python environment
pip install -e moa_python

```

If installing moa_python with the intention to develop, some additional configuration is helpful:


Install moa_python in editable mode with the appropriate developer tools

- ``".[develop]"`` is for the linting and code checking tools
- ``".[docs]"`` is for the documentation building tools. Ideally, developers should also be
contributing to the documentation, and therefore checking that
the documentation builds locally.

```bash
pip install -e ".[develop, docs]"
```
Turn on the linting and code checking tools

```bash
pre-commit install
```

If everything is configured correctly, any changes made to the source
code will be available directly through your local Python. Remember
to re-import the FLASC module when changes are made if you are working
in an interactive environment like Jupyter.
5 changes: 3 additions & 2 deletions docs/intro.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# moa_python

MOA Python
MOA Python is a companion tool for Hercules (www.github.com/NREL/hercules) and is designed to facilitate the analysis of large datasets.



Small edit
2 changes: 1 addition & 1 deletion docs/kestrel_tunneling.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# README.md
# Kestrel Tunneling

This subfolder demonstrates how to implement tunneling for jupyter notebooks into NREL's HPC system kestrel

Expand Down

0 comments on commit 8fd75e3

Please sign in to comment.