Skip to content

Commit

Permalink
docs updated
Browse files Browse the repository at this point in the history
  • Loading branch information
mommermi committed Feb 5, 2020
1 parent dab187f commit 67d32a8
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 2 deletions.
24 changes: 24 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,30 @@ Please that ``cloudynight`` only utilizes the more efficient ``lightgbm``
classifier. The ResNet code is also included in ``scripts/`` for the sake
completeness.

Requirements
------------

``cloudynight`` requires the following Python modules to be available
(version numbers in parentheses signify the version numbers that were used in
building this code):

* numpy (1.16.3)
* scipy (1.2.1)
* matplotlib (3.0.3)
* pandas (0.25.3)
* sep (1.0.3)
* astropy (4.0)
* scikit-image (0.15.0)
* lightgbm (2.2.3)
* scikit-learn (0.22.1)
* astroplan (0.4)

The use of the ResNet implementation requires additional modules:

* pytorch (1.3.1)
* tqdm (4.36.1)


Use
---

Expand Down
6 changes: 4 additions & 2 deletions scripts/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,7 @@ The following example scripts are included here:
* ``resnet.py``: train the ResNet model and derive accuracy scores

All these example scripts are intended to work with the example data
provided. However, it should not be hard to modify the scripts to work with
data from other all-sky cameras.
provided and should be run in this order.

It should not be hard to modify these scripts to work with
data from other all-sky cameras.

0 comments on commit 67d32a8

Please sign in to comment.