Fix missing _build directory

GalSim-developers · Nov 6, 2024 · 6454870 · 6454870
1 parent 1133d67
commit 6454870
Show file tree

Hide file tree

Showing 40 changed files with 6,528 additions and 0 deletions.
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/euclidlike.doctree b/docs/_build/doctrees/euclidlike.doctree
diff --git a/docs/_build/doctrees/euclidlike_imsim.doctree b/docs/_build/doctrees/euclidlike_imsim.doctree
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/modules.doctree b/docs/_build/doctrees/modules.doctree
diff --git a/docs/_build/doctrees/scripts.doctree b/docs/_build/doctrees/scripts.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: cec21682d6cc0df78936fbd198ac0c57
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_modules/euclidlike/backgrounds.html b/docs/_build/html/_modules/euclidlike/backgrounds.html
diff --git a/docs/_build/html/_modules/euclidlike/bandpass.html b/docs/_build/html/_modules/euclidlike/bandpass.html
diff --git a/docs/_build/html/_modules/euclidlike/euclidlike_psf.html b/docs/_build/html/_modules/euclidlike/euclidlike_psf.html
diff --git a/docs/_build/html/_modules/euclidlike/euclidlike_wcs.html b/docs/_build/html/_modules/euclidlike/euclidlike_wcs.html
diff --git a/docs/_build/html/_modules/index.html b/docs/_build/html/_modules/index.html
@@ -0,0 +1,98 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Overview: module code &#8212; GalSim-Euclid-Like 0.0.1 documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d1102ebc" />
+    <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
+    <script src="../_static/documentation_options.js?v=d45e8c67"></script>
+    <script src="../_static/doctools.js?v=9bcbadda"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+
+  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+
+
+
+  </head><body>
+
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+
+
+          <div class="body" role="main">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="euclidlike/backgrounds.html">euclidlike.backgrounds</a></li>
+<li><a href="euclidlike/bandpass.html">euclidlike.bandpass</a></li>
+<li><a href="euclidlike/euclidlike_psf.html">euclidlike.euclidlike_psf</a></li>
+<li><a href="euclidlike/euclidlike_wcs.html">euclidlike.euclidlike_wcs</a></li>
+</ul>
+
+          </div>
+
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
+        <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="../index.html">GalSim-Euclid-Like</a></h1>
+
+
+
+
+
+
+
+
+
+<search id="searchbox" style="display: none" role="search">
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</search>
+<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="../index.html">Documentation overview</a><ul>
+  </ul></li>
+</ul>
+</div>
+
+
+
+
+
+
+
+
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &#169;2024, Rachel Mandelbaum, Axel Guinot, Federico Berlfein, Andy Park, Xiangchong Li, Michael Troxel, Tianqing Zhang.
+
+      |
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
+
+    </div>
+
+
+
+
+  </body>
+</html>
diff --git a/docs/_build/html/_sources/euclidlike.rst.txt b/docs/_build/html/_sources/euclidlike.rst.txt
@@ -0,0 +1,53 @@
+euclidlike package
+==================
+
+Submodules
+----------
+
+euclidlike.backgrounds module
+-----------------------------
+
+.. automodule:: euclidlike.backgrounds
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+euclidlike.bandpass module
+--------------------------
+
+.. automodule:: euclidlike.bandpass
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+euclidlike.euclidlike\_psf module
+---------------------------------
+
+.. automodule:: euclidlike.euclidlike_psf
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+euclidlike.euclidlike\_wcs module
+---------------------------------
+
+.. automodule:: euclidlike.euclidlike_wcs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+euclidlike.instrument\_params module
+------------------------------------
+
+.. automodule:: euclidlike.instrument_params
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: euclidlike
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_build/html/_sources/euclidlike_imsim.rst.txt b/docs/_build/html/_sources/euclidlike_imsim.rst.txt
@@ -0,0 +1,109 @@
+euclidlike\_imsim package
+=========================
+
+Submodules
+----------
+
+euclidlike\_imsim.bandpass module
+---------------------------------
+
+.. automodule:: euclidlike_imsim.bandpass
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+euclidlike\_imsim.ccd module
+----------------------------
+
+.. automodule:: euclidlike_imsim.ccd
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+euclidlike\_imsim.detector\_physics module
+------------------------------------------
+
+.. automodule:: euclidlike_imsim.detector_physics
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+euclidlike\_imsim.noise module
+------------------------------
+
+.. automodule:: euclidlike_imsim.noise
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+euclidlike\_imsim.obseq module
+------------------------------
+
+.. automodule:: euclidlike_imsim.obseq
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+euclidlike\_imsim.photonOps module
+----------------------------------
+
+.. automodule:: euclidlike_imsim.photonOps
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+euclidlike\_imsim.psf module
+----------------------------
+
+.. automodule:: euclidlike_imsim.psf
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+euclidlike\_imsim.scafile module
+--------------------------------
+
+.. automodule:: euclidlike_imsim.scafile
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+euclidlike\_imsim.skycat module
+-------------------------------
+
+.. automodule:: euclidlike_imsim.skycat
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+euclidlike\_imsim.stamp module
+------------------------------
+
+.. automodule:: euclidlike_imsim.stamp
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+euclidlike\_imsim.utils module
+------------------------------
+
+.. automodule:: euclidlike_imsim.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+euclidlike\_imsim.wcs module
+----------------------------
+
+.. automodule:: euclidlike_imsim.wcs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: euclidlike_imsim
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
@@ -0,0 +1,63 @@
+GalSim-Euclid-Like
+==================
+
+Helper functions to generate simulations of Euclid-like images using GalSim.
+
+This repository contains information about the Euclid space telescope and survey that is needed to
+produce simulations using `GalSim <https://github.com/GalSim-developers/GalSim>`_.  Some of the
+information provided is approximate, aimed towards fast simulations rather than full accuracy in
+representation of Euclid images.  Places where the information is only approximate are flagged and
+described in the docstring, and we particularly highlight that the PSF is only approximate;
+for details, see the docstring of the ``getPSF()`` method.  This library should enable generation of
+Euclid-like images of sufficient fidelity for preliminary exploration of object detection,
+photometry, deblending, and joint analysis with ground-based observatories.  For
+applications requiring high precision such as weak lensing, the higher fidelity simulations
+available within the Euclid Consortium should be used.
+
+This repository includes two distinct packages:
+
+* ``euclidlike``: has basic observatory, instrumentation, and survey information for Euclid.
+  This package can be used on its own along with GalSim to produce Euclid-like simulations.
+
+* ``euclidlike_imsim``: has configuration scripts to produce large-scale Euclid-like simulation runs
+  based on the information in ``euclidlike``. It is based heavily on `roman_imsim <https://github.com/matroxel/roman_imsim>`_.
+
+
+References
+==================
+
+For more information about `GalSim <https://github.com/GalSim-developers/GalSim>`_, please see its README and documentation.
+
+For more information about Euclid, please see the `Euclid Consortium website <https://www.euclid-ec.org/>`_ and papers linked from there.
+
+Attribution for software and data used by particular routines in this library is given in the docstring for the relevant routine.
+
+Installation
+==================
+
+Please view the `installation instructions <INSTALL.rst>`_ for details on how to install GalSim-Euclid-Like.
+
+Downloading relevant data
+==================                                                                              
+The Euclid-like PSF is constructed from precomputed oversampled images on a grid in focal plane position and wavelength. To use the full FOV PSF within GalSim-Euclid-Like, the images must be downloaded by running::
+
+    $ euclidlike_download_psf
+
+in the terminal after installation of GalSim-Euclid-Like. To install in an alternative directory to the default, use the ``--dir`` argument. Refer to the ``getPSF`` documentation for further details about the PSF. 
+
+Getting started
+==================                                                                             
+
+Please see the examples/ directory for demos illustrating the use of this code.
+
+Communicating with the developers
+==================
+Feel free to `open a GitHub issue <https://github.com/GalSim-developers/GalSim-Euclid-Like/issues>`_ to reach the developers with questions, comments, and bug reports.  New contributors are also welcome and can indicate their interest in developing this code base through the Issues.
+
+Attribution
+==================                                   
+
+This software is open source and may be used according to the terms of its `license <LICENSE>`_.
+
+When using this software, please provide the URL to the repository in the resulting paper or note.  Once there is a Zenodo DOI or journal article, this README will be updated and we will ask those using the code in their research to cite the relevant journal article.
+
diff --git a/docs/_build/html/_sources/modules.rst.txt b/docs/_build/html/_sources/modules.rst.txt
@@ -0,0 +1,9 @@
+GalSim-Euclid-Like
+==================
+
+.. toctree::
+   :maxdepth: 4
+
+   euclidlike
+   euclidlike_imsim
+   scripts
diff --git a/docs/_build/html/_sources/scripts.rst.txt b/docs/_build/html/_sources/scripts.rst.txt
@@ -0,0 +1,29 @@
+scripts package
+===============
+
+Submodules
+----------
+
+scripts.download\_psf module
+----------------------------
+
+.. automodule:: scripts.download_psf
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+scripts.make\_euclidlike\_pupil\_plane module
+---------------------------------------------
+
+.. automodule:: scripts.make_euclidlike_pupil_plane
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: scripts
+   :members:
+   :undoc-members:
+   :show-inheritance: