Skip to content

Commit

Permalink
make documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hexajonal committed Dec 7, 2024
1 parent a687713 commit 66bf00d
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
27 changes: 26 additions & 1 deletion docs/content/usage.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
Usage
------
=========================

Overview
----------

PyStarshade will compute fields and PSF files for a given starshade configuration and store these on disk for simulating imaging of new scenes.
To start pick a starshade configuration , some options provided are ('wfirst', 'hwo', 'habex'). The starshade configuration is termed a drm (design reference mission)
Expand Down Expand Up @@ -45,4 +48,26 @@ Note: there is an important setting called 'chunk', if this is invoked a chunked
hwo_starshade.gen_psf_basis(pupil_type = pupil_type)
focal_intensity = hwo_starshade.gen_scene(pupil_type, source_field.astype(np.float32), 500e-9)
Fourier propagator
-------------------

In PyStarshade, the classes and functions are generally designed to act on a spatial grid of size N * N, where N is an odd number and the origin is at (N/2, N/2).

Data
----------

The data directory is structured like so:

.. code-block:: bash
data
├── fields
├── masks
│   ├── starshade_edge_files
│   └── starshade_masks
├── out
├── psf
├── pupils
└── scenes
If you have new masks for the starshade, or telescope aperture masks, place them in the correct folders (starshade_masks and pupils respectively).
5 changes: 5 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,11 @@ Contents
--------

.. toctree::
:caption: Usage
content/usage
content/fft

.. toctree::
:caption: Utilities
content/test

0 comments on commit 66bf00d

Please sign in to comment.