diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index 69fe55ec..00000000 --- a/docs/Makefile +++ /dev/null @@ -1,19 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -SOURCEDIR = source -BUILDDIR = build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 4d9eb83d..00000000 --- a/docs/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=source -set BUILDDIR=build - -if "%1" == "" goto help - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ - exit /b 1 -) - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% - -:end -popd diff --git a/docs/to-do-list.txt b/docs/to-do-list.txt index 45d66192..68963dd6 100644 --- a/docs/to-do-list.txt +++ b/docs/to-do-list.txt @@ -8,27 +8,18 @@ ScopeSim WHAT: Implement spatial-spectral Field-of-View objects WHAT: Re-write of FOV-Manager class to accomodate 2+1D FOV objects -- Simplify Effect object API - WHY: Makes "custom" effect objects easier to write for 3rd parties (e.g. JU Pott's astrometry group) - WHAT: Remove the "fov_grid" method used by FOV-Manager. Replace it with a further apply_to loop when initialising the in-memory instrument model - -- Add 3D Detector-Cube object - WHY: Enables very quick "science grade" spectroscopy data products to be produced - WHY: Paves the way for ETC-mode for ScopeSim - WHAT: Write new DetectorCube class, which piggy-backs the current Detector class - - Add ETC mode WHY: Quick generation of ETC table data for delivery to ESO (and whomever else wants it) WHY: Increases future usability by astronomers when writing observing proposals WHAT: Add functions for determining SNR through photometry, line integration, or per-pixel WHAT: Add DetectorETC class, which contains flux and noise images, and returns a table of SNR values - + - Add simple Coronographic Effects (as much as possible) WHY: Elephant in the room. Needs to be included. WHAT: An Effect wrapper for a grid of PSFs for different coronographic conditions - Add "observatory like" functionality (specifiy RA, Dec, obs date) - WHY: Most often requested feature is to add RA and Dec to observing parameters. + WHY: Most often requested feature is to add RA and Dec to observing parameters. WHY: Atmospheric conditions change with Zenith distance, which is related to RA and Dec WHY: Helps astronomers better conceptualise their observations WHAT: ScopeSim will pull in a list of objects from Simbad and add these to the background of the images @@ -38,18 +29,6 @@ ScopeSim WHY: For more accurate realistions of the most important external noise sources WHAT: Write an interface standard for these two packages. Possibly liase with the developers so that the packages can deliver "ScopeSim-Ready" objects -- Remove dependency on astropy units - WHY: They are slow - WHAT: Define a set of internal units for Scopesim. Replace all astropy.unit references with internally consistent units propogation - -- Remove dependency on astropy HDU objects - WHY: They are slow. Too many internal checks on the header keywords. Factor of 10x speed increase when using ScopeSim's interal "PoorMansHeader" object - WHAT: Expand PoorMansHeader to cover all use cases, add minimal units checks, replace all occurences of astropy HDU objects - -- Remove dependency on Synphot spectra objects - WHY: They are slow. Based on astropy interpolation objects and astropy units. Too many checks. - WHAT: Write a new high-speed spectral interpolatio class based on the scipy.interpolate objects. - - Add time-dependency to the observation sequences WHY: To allow realistic astrometry observations WHAT: Add a time parameter to the on-sky Source objects @@ -58,11 +37,11 @@ ScopeSim ScopeSim_Templates ------------------ -- Add ArtPop wrapper. ArtPop is a better (3rd-party) generator for (old and new) stellar population ScopeSim-Source objects. +- Add ArtPop wrapper. ArtPop is a better (3rd-party) generator for (old and new) stellar population ScopeSim-Source objects. WHY: Allows users to make more realistic on-sky targets using isochrone libraries. WHAT: Wrap the ArtPop package into a ScopeSim_Templates sub-module WHAT: Code and submit a pull request to the ArtPop developers to enable ArtPop to generate ScopeSim-like Source objects - + - Add Vela simualtion wrapper. Vela is a set of high-res simulated galaxies observed over cosmic time WHY: Allows users to add realisitc galaxies to their images with spatial resolutions better than MICADO for any redshift. Useful for imaging feasibility studies WHAT: Write a wrapper sub-module that fetches data from the Vela server (or from a copy hosted at Uni-Vienna) @@ -91,13 +70,13 @@ IRDB - Automatic file consistency testing WHY: Automatic tests let the author know if the file(s) they add will break or significantly alter the expected simulation outputs WHAT: Code to check units and min, max values - + - Automated instrument performance estimates WHY: Lets users and authors know what the expected performance of the instrument will be, based on the data files and settings included in the packages WHAT: Definition of how to determine instrument performance WHAT: Code for running and extracting the instrument performance parameters - - + + Documentation and Testing ------------------------- - Update and expand astronomy Use-case documentation diff --git a/docs/virtual_envs.rst b/docs/virtual_envs.rst deleted file mode 100644 index 8aa12d14..00000000 --- a/docs/virtual_envs.rst +++ /dev/null @@ -1,23 +0,0 @@ -TLDR to virtual environments -============================ - -1. Install the virtualenv package:: - - $ pip install virtualenv - -2. Install a version of Python in a folder somewhere WITHOUT adding to PATH using the normal python installers - -3. Set up virtualenv with:: - - $ virtualenv -p - $ virtualenv venv_py39 -p Python39\python.exe - -4. Activate venv with:: - - $ venv_py39\Scripts\activate.bat - -5. Install all packages needed with pip - -6. Deactivate venv with:: - - $ deactivate