Skip to content

Commit a0fc12c

Browse files
Jammy2211Jammy2211
authored andcommitted
docs
1 parent 125e14d commit a0fc12c

2 files changed

Lines changed: 15 additions & 22 deletions

File tree

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ PyAutoLens-JAX: Open-Source Strong Lensing
4242

4343
`Installation Guide <https://pyautolens.readthedocs.io/en/latest/installation/overview.html>`_ |
4444
`readthedocs <https://pyautolens.readthedocs.io/en/latest/index.html>`_ |
45-
`Introduction on Binder <https://mybinder.org/v2/gh/Jammy2211/autolens_workspace/release?filepath=start_here.ipynb>`_ |
45+
`Introduction on Colab <https://colab.research.google.com/github/Jammy2211/autolens_workspace/blob/release/start_here.ipynb>`_ |
4646
`HowToLens <https://pyautolens.readthedocs.io/en/latest/howtolens/howtolens.html>`_
4747

4848
.. image:: https://github.com/Jammy2211/PyAutoLogo/blob/main/gifs/pyautolens.gif?raw=true

docs/overview/overview_2_new_user_guide.rst

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,18 @@ New User Guide
77
different data types and it is used for a variety of different science cases. This means the documentation is quite
88
extensive, and it may initially be difficult to find the example script you need.
99

10-
The `autolens_workspace` has five `start_here.ipynb` notebooks, and you need to determine which is most relevant
11-
to your scientific interests:
10+
The ``autolens_workspace`` has five ``start_here.ipynb`` notebooks, and you need to determine which is most relevant
11+
to your scientific interests.
1212

13-
- ``start_here_imaging.ipynb``: Galaxy scale strong lenses observed with CCD imaging (e.g. Hubble, James Webb).
14-
- ``start_here_interferometer.ipynb``: Galaxy scale strong lenses observed with interferometer data (e.g. ALMA).
15-
- ``start_here_point_source.ipynb``: Galaxy scale strong lenses with a lensed point source (e.g. lensed quasars).
16-
- ``start_here_group.ipynb``: Group scale strong lenses where there are 2-10 lens galaxies.
17-
- ``start_here_cluster.ipynb``: Cluster scale strong lenses with 2+ lenses and 5+ source galaxies.
13+
You can access the notebooks by clicking on the embedded links below:
1814

19-
You can access them via Google Colab using the following URLs:
15+
- `imaging/start_here.ipynb <https://colab.research.google.com/github/Jammy2211/autolens_workspace/blob/release/notebooks/imaging/start_here.ipynb>`_: Galaxy scale strong lenses observed with CCD imaging (e.g. Hubble, James Webb).
16+
- `interferometer/start_here.ipynb <https://colab.research.google.com/github/Jammy2211/autolens_workspace/blob/release/notebooks/interferometer/start_here.ipynb>`_: Galaxy scale strong lenses observed with interferometer data (e.g. ALMA).
17+
- `point_source/start_here.ipynb <https://colab.research.google.com/github/Jammy2211/autolens_workspace/blob/release/notebooks/point_source/start_here.ipynb>`_: Galaxy scale strong lenses with a lensed point source (e.g. lensed quasars).
18+
- `group/start_here.ipynb <https://colab.research.google.com/github/Jammy2211/autolens_workspace/blob/release/notebooks/group/start_here.ipynb>`_: Group scale strong lenses where there are 2-10 lens galaxies.
19+
- `cluster/start_here.ipynb <https://colab.research.google.com/github/Jammy2211/autolens_workspace/blob/release/notebooks/cluster/start_here.ipynb>`_: Cluster scale strong lenses with 2+ lenses and 5+ source galaxies.
2020

21-
- ``start_here_imaging.ipynb``: https://colab.research.google.com/github/Jammy2211/autolens_workspace/blob/release/start_here_imaging.ipynb
22-
- ``start_here_interferometer.ipynb``: https://colab.research.google.com/github/Jammy2211/autolens_workspace/blob/release/start_here_interferometer.ipynb
23-
- ``start_here_point_source.ipynb``: https://colab.research.google.com/github/Jammy2211/autolens_workspace/blob/release/start_here_point_source.ipynb
24-
- ``start_here_group.ipynb``: https://colab.research.google.com/github/Jammy2211/autolens_workspace/blob/release/start_here_group.ipynb
25-
- ``start_here_cluster.ipynb``: https://colab.research.google.com/github/Jammy2211/autolens_workspace/blob/release/start_here_cluster.ipynb
26-
27-
If you are still unsure based on the brief descriptions above, answer the following two questions to work out
28-
where to start
21+
If you are unsure based on the brief descriptions above, answer the following two questions to work out where to start.
2922

3023
What Scale Lens?
3124
----------------
@@ -38,22 +31,22 @@ There are three scales to choose from:
3831
If you're interested in galaxy scale lenses, go to the question below called "What Data Type?".
3932

4033
- **Group Scale**: Strong Lens Groups contains 2-10 lens galaxies, normally with one main large galaxy responsible for the majority of lensing.
41-
They also typically lens just one source galaxy. If you are interested in groups, go to the `start_here_group.ipynb` notebook.
34+
They also typically lens just one source galaxy. If you are interested in groups, go to the ``group/start_here.ipynb`` notebook.
4235

4336
- **Cluster Scale**: Strong Lens Galaxy clusters often contained 20-50, or more, lens galaxies, lensing 10, or more, sources galaxies.
44-
If you are interested in clusters, go to the `start_here_cluster.ipynb` notebook.
37+
If you are interested in clusters, go to the ``cluster/start_here.ipynb`` notebook.
4538

4639
What Dataset Type?
4740
------------------
4841

4942
If you are interested in galaxy-scale strong lenses, you now need to decide what type of strong lens data you are
5043
interested in:
5144

52-
- **CDD Imaging**: For image data from telescopes like Hubble and James Webb, go to `start_here_imaging.ipynb`.
45+
- **CDD Imaging**: For image data from telescopes like Hubble and James Webb, go to ``imaging/start_here.ipynb``.
5346

54-
- **Interferometer**: For radio / sub-mm interferometer from instruments like ALMA, go to `start_here_interferometer.ipynb`.
47+
- **Interferometer**: For radio / sub-mm interferometer from instruments like ALMA, go to ``interferometer/start_here.ipynb``.
5548

56-
- **Point Sources**: For strongly lensed point sources (e.g. lensed quasars, supernovae), go to `start_here_point_source.ipynb`.
49+
- **Point Sources**: For strongly lensed point sources (e.g. lensed quasars, supernovae), go to ``point_source/start_here.ipynb``.
5750

5851
Still Unsure?
5952
-------------

0 commit comments

Comments
 (0)