Skip to content

Commit 422b6e4

Browse files
fix(README): remove references of data/
1 parent 0bc2663 commit 422b6e4

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ __pycache__/
1010

1111
plots/
1212

13+
data/
14+
1315
# Distribution / packaging
1416
.Python
1517
build/

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,15 @@
33

44
## Basic Guide to Codebase
55

6-
- `data` - Contains the acquired `.fits` files that contain the light curves for all objects classified as EBs.
6+
[//]: # (- `data` - Contains the acquired `.fits` files that contain the light curves for all objects classified as EBs.)
77
- `datagen` - Contains the data generation and acquisition scheme to get the files in `data`.
88
- `logbooks` - Personal Logbooks of us determining our ideal algorithm. It uses an older version of the codebase.
99
- `notebooks` - Notebooks to test our code and visualise them, and also to give examples of usage
1010
- `pipeline` - Currently contains (early-stage) versions of our improved library code that will later be deployed on PyPI.
1111
- `pipelining` - Older versions of `datagen`.
1212
- `src` and `utils` - Older versions of `pipeline`.
13-
- `manual_classification.xlsx` - Post Algorithm Manual Classification done by us.
13+
- `manual_classification.xlsx` - Post Algorithm Manual Classification done by us.
14+
15+
Do note that in our codebase, you will see references to a `data/` folder. This folder contains the acquired `.fits`
16+
files that contain the light curves for all objects classified as EBs. You can install this by running
17+
`datagen/load.sh`.

0 commit comments

Comments
 (0)