Proofread

docs/api/index.rst

@@ -3,10 +3,10 @@ API
 
 This is cosipy's Application Programming Interface (API). It is an exhaustive list of all available classes and their properties, as well as the inputs and outputs of each method.
 
-If you are instead interested on an overview on how to use cosipy, see out `tutorial series instead <../tutorials/index.html>`_.
+If you are instead interested in an overview on how to use cosipy, see out `tutorial series instead <../tutorials/index.html>`_.
 
 .. warning::
-    Under construction. The description of some method are still missing. If you need the description of a particular class, please open an `issue <https://github.com/cositools/cosipy/issues>`_ so we can priotize it.
+    Under construction. The description of some methods is still missing. If you need the description of a particular class, please open an `issue <https://github.com/cositools/cosipy/issues>`_ so we can prioritize it.
 
 .. toctree::
    :maxdepth: 2
@@ -19,3 +19,5 @@ If you are instead interested on an overview on how to use cosipy, see out `tuto
    ts_map
    image_deconvolution
 
+
+

docs/index.rst

@@ -3,17 +3,17 @@ Welcome to cosipy's documentation!
 
 The cosipy library is `COSI <https://cosi.ssl.berkeley.edu/>`_'s high-level analysis software. It allows you to extract imaging and spectral information from the data, as well as to perform statistical model comparisons. The cosipy products are meant to be ready for interpretation.
 
-The main repository is hosted in https://github.com/cositools/cosipy
+The main repository is hosted at https://github.com/cositools/cosipy
 
 In the following sections you will find:
 
 - Installation instructions
 - A tutorial series explaining the basics of various components of cosipy
 - Further usage examples
-- The Application Programming Interface (API), describing the various available classes, their properties, and usage.
+- The Application Programming Interface (API), describes the various available classes, their properties, and usage.
 
 .. warning::
-   While many features are already available, cosipy is still actively under developement. COSI is scheduled to launch in 2027. In prepation, the cosipy team will be releasing alpha versions with approximately an annual cadence. You feedback will be greatly appreciated! Note, however, that these are not stable releases and various components can be modified or deprecated in the near future.
+   While many features are already available, cosipy is still actively under development. COSI is scheduled to launch in 2027. In preparation, the cosipy team will be releasing alpha versions with approximately an annual cadence. Your feedback will be greatly appreciated! Note, however, that these are not stable releases and various components can be modified or deprecated shortly.
 
 
 Contributing

docs/install.rst

@@ -29,11 +29,11 @@ Optional but recommended step: install a conda environment::
   conda create -n <cosipy_env_name> python=3.10 pip
   conda activate <cosipy_env_name>
 
-Also optional but recommented: before installing cosipy, install the main
-dependencies from source (similar
+Also optional but recommended: before installing cosipy, install the main
+dependencies from the source (similar
 procedure as for cosipy below). These are histpy, mhealpy, scoords, threeml and
 astromodels. The reason is that these libraries might be changing rapidly to
-accomodate new features in cosipy. 
+accommodate new features in cosipy. 
 
 Do the following (preferably inside a conda environment)::
 
@@ -48,7 +48,7 @@ Testing
 .......
 
 .. warning::
-    Under construction. Unit tests not ready.
+    Under construction. Unit tests are not ready.
 
 When you make a change, check that it didn't break something by running::
 
@@ -69,10 +69,11 @@ You need pandoc, sphinx, nbsphinx, sphinx_rtd_theme and mock. Using conda::
 
     conda install -c conda-forge pandoc nbsphinx sphinx_rtd_theme mock
 
-Onece you have this requirements, run::
+Once you have these requirements, run::
 
     cd docs
     make html
 
 To read the documentation, open ``docs/_build/html/index.html`` in a browser.
 
+

docs/tutorials/index.rst

@@ -1,9 +1,9 @@
 Tutorials
 =========
 
-This are a series of tutorials explaining step by step the various components of the `cosipy` library and how to use them. Although they are rendered as webpage here, these are interactive Python notebooks (ipynb) that you can execute and modify, distributed as part of the cosipy repository.
+This is a series of tutorials explaining step by step the various components of the `cosipy` library and how to use it. Although they are rendered as a webpage here, these are interactive Python notebooks (ipynb) that you can execute and modify, distributed as part of the cosipy repository.
 
-If you are interested instead on the description each class and method, please see our `API <../api/index.html>`_ section.
+If you are interested instead of the description of each class and method, please see our `API <../api/index.html>`_ section.
 
 List of tutorials and contents, as a link to the corresponding Python notebook in the repository:
 
@@ -12,7 +12,7 @@ List of tutorials and contents, as a link to the corresponding Python notebook i
   - Data format, binned and unbinned
   - Binning the data in both local and galactic coordinates
   - Combining files.
-  - Inspect and plotting the data
+  - Inspecting and plotting the data
 
 2. Spacecraft orientation and location `(ipynb) <https://github.com/cositools/cosipy/tree/main/docs/tutorials/Point_source_resonse.ipynb>`_
 
@@ -29,7 +29,7 @@ List of tutorials and contents, as a link to the corresponding Python notebook i
 4. TS Map: localizing a GRB `(ipynb) <https://github.com/cositools/cosipy/tree/main/docs/tutorials/ts_map/Parallel_TS_map_computation_DC2.ipynb>`_
   - TS calculation
   - Meaning of the TS map and how to compute confidence contours
-  - Computing a TS map, get the best location and estimate the error
+  - Computing a TS map, getting the best location and estimating the error
 
 5. Fitting the spectrum of a GRB `(ipynb) <https://github.com/cositools/cosipy/tree/main/docs/tutorials/spectral_fits/continuum_fit/grb/SpectralFit.ipynb>`_
 
@@ -38,11 +38,11 @@ List of tutorials and contents, as a link to the corresponding Python notebook i
   - Mechanics of background estimation.
   - Fitting a simple power law, assuming you know the time of the GRB
   - Plotting the result
-  - Compareing the result with the data
+  - Comparing the result with the data
 
 6. Fitting the spectrum of the Crab `(ipynb) <https://github.com/cositools/cosipy/tree/main/docs/tutorials/spectral_fits/continuum_fit/crab/SpectralFit_Crab.ipynb>`_
 
-  - Analysing a continous sources transiting in the sky.
+  - Analysing a continuous source transiting in the sky.
 
 7. Extended source model fitting `(ipynb) <https://github.com/cositools/cosipy/blob/main/docs/tutorials/spectral_fits/extended_source_fit/diffuse_511_spectral_fit.ipynb>`_
 
@@ -51,15 +51,15 @@ List of tutorials and contents, as a link to the corresponding Python notebook i
   - Fitting an extended source
 
 8. Image deconvolution `(ipynb) <https://github.com/cositools/cosipy/tree/main/docs/tutorials/image_deconvolution/511keV/ScAttBinning/511keV-DC2-ScAtt-ImageDeconvolution.ipynb>`_
-  - Explain the RL algorithm. Reference the previous example. Explain difference with TS map.
+  - Explain the RL algorithm. Reference the previous example. Explain the difference with a TS map.
   - Scatt binning and its advantages/disadvantages
   - Fitting the 511 diffuse emission.
 
 9. TODO: Source injector
   - Nice to have: allow theorist to test the sensitivity of their models
 
 .. warning::
-   Under construction. Some of the explanation described above might be missing. However, the notebook are fully functional. If you a question not yet covered by the tutorials, please discussion `issue <https://github.com/cositools/cosipy/discussions>`_ so we can priotize it.
+   Under construction. Some of the explanations described above might be missing. However, the notebooks are fully functional. If you have a question not yet covered by the tutorials, please discuss `issue <https://github.com/cositools/cosipy/discussions>`_ so we can prioritize it.
 
 .. toctree::
    :maxdepth: 1
@@ -72,3 +72,5 @@ List of tutorials and contents, as a link to the corresponding Python notebook i
    Fitting the spectrum of the Crab <spectral_fits/continuum_fit/crab/SpectralFit_Crab.ipynb>
    Extended source model fitting <spectral_fits/extended_source_fit/diffuse_511_spectral_fit.ipynb>
    Image deconvolution <image_deconvolution/511keV/ScAttBinning/511keV-DC2-ScAtt-ImageDeconvolution.ipynb>
+
+