Skip to content

docs: fix cluster dataset path prose + document simulator folder #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jammy2211 merged 1 commit into from
Aug 20, 2026
Merged

docs: fix cluster dataset path prose + document simulator folder #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions notebooks/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ a strong lens.
- `chapter_4_scaling_up_lensing`: How to scale lens modeling up to extra galaxies, multi-galaxy lenses,
scaling relations, groups, clusters and weak lensing.
- `chapter_optional`: Optional tutorials.
- `simulator`: Scripts used to simulate the strong lens datasets fitted throughout the **HowToLens** lectures.

# Full Explanation

Expand Down
4 changes: 2 additions & 2 deletions notebooks/simulator/cluster.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@
"__Dataset Paths__\n",
"\n",
"The `dataset_type` describes the type of data being simulated and `dataset_name` gives it a\n",
"descriptive name. The cluster dataset is output to `howtolens/dataset/cluster/simple`, which the\n",
"descriptive name. The cluster dataset is output to `dataset/cluster/simple`, which the\n",
"tutorial on cluster-scale lensing loads via the auto-simulation guard."
]
},
Expand Down Expand Up @@ -766,7 +766,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The dataset can be viewed in the folder `howtolens/dataset/cluster/simple`."
"The dataset can be viewed in the folder `dataset/cluster/simple`."
]
}
],
Expand Down
1 change: 1 addition & 0 deletions scripts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ a strong lens.
- `chapter_4_scaling_up_lensing`: How to scale lens modeling up to extra galaxies, multi-galaxy lenses,
scaling relations, groups, clusters and weak lensing.
- `chapter_optional`: Optional tutorials.
- `simulator`: Scripts used to simulate the strong lens datasets fitted throughout the **HowToLens** lectures.

# Full Explanation

Expand Down
4 changes: 2 additions & 2 deletions scripts/simulator/cluster.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
__Dataset Paths__

The `dataset_type` describes the type of data being simulated and `dataset_name` gives it a
descriptive name. The cluster dataset is output to `howtolens/dataset/cluster/simple`, which the
descriptive name. The cluster dataset is output to `dataset/cluster/simple`, which the
tutorial on cluster-scale lensing loads via the auto-simulation guard.
"""
dataset_type = "cluster"
Expand Down Expand Up @@ -525,5 +525,5 @@ def jitted_solve(tracer, source_plane_coordinate):
)

"""
The dataset can be viewed in the folder `howtolens/dataset/cluster/simple`.
The dataset can be viewed in the folder `dataset/cluster/simple`.
"""
Loading