Skip to content

Commit be7b5f5

Browse files
updated README for comments; pyproject.toml for notebook; .gitignore for a hidden files
1 parent fca5aee commit be7b5f5

File tree

3 files changed

+5
-1
lines changed

3 files changed

+5
-1
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ __pycache__/
1111
# Distribution / packaging
1212
.Python
1313
build/
14+
deepszsim.egg-info/
1415
develop-eggs/
1516
dist/
1617
downloads/
@@ -129,3 +130,5 @@ dmypy.json
129130

130131
# Pyre type checker
131132
.pyre/
133+
134+
notebooks/sbi-logs/

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ A full list of potential inputs is documented in `settings/config.yaml` and you
4343

4444
### Tests
4545

46-
Tests are provided in the `tests` directory. They are automatically run via CircleCI on pushes to the repository. Users can verify tests with `python -m pytest tests/*`.
46+
Tests are provided in the `tests` directory. They are automatically run via CircleCI on pushes to the repository in this [workflow](https://github.com/deepskies/DeepSZSim/actions/runs/14297088348/workflow). Users can verify tests and coverage locally with `python -m pytest tests/*`.
4747

4848
### Example
4949

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ dependencies = [
1717
"colossus >= 1.3.0",
1818
"tqdm >= 4.66.0",
1919
"pixell == 0.17.3",
20+
"notebook>=7.2.2"
2021
]
2122

2223
[tool.dev-dependencies]

0 commit comments

Comments
 (0)