Made a simple example

NickSwainston · Jan 26, 2022 · f4555af · f4555af
1 parent c5a093b
commit f4555af
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 6 deletions.
diff --git a/docs/example_scripts/simple_example.py b/docs/example_scripts/simple_example.py
@@ -0,0 +1,7 @@
+from pulsar_spectra.catalogues import collect_catalogue_fluxes
+from pulsar_spectra.spectral_fit import find_best_spectral_fit
+
+cat_list = collect_catalogue_fluxes()
+pulsar = 'J1453-6413'
+freqs, fluxs, flux_errs, refs = cat_list[pulsar]
+find_best_spectral_fit(pulsar, freqs, fluxs, flux_errs, refs, plot_best=True)
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -0,0 +1,32 @@
+Examples
+========
+
+Simple example
+--------------
+
+The following can be run to fit J1453-6413
+
+.. code-block:: python
+
+    from pulsar_spectra.catalogues import collect_catalogue_fluxes
+    from pulsar_spectra.spectral_fit import find_best_spectral_fit
+
+    cat_list = collect_catalogue_fluxes()
+    pulsar = 'J1453-6413'
+    freqs, fluxs, flux_errs, refs = cat_list[pulsar]
+    find_best_spectral_fit(pulsar, freqs, fluxs, flux_errs, refs, plot_best=True)
+
+This will produce J1453-6413_simple_power_law_fit.png
+
+.. image:: figures/J1453-6413_simple_power_law_fit.png
+  :width: 800
+
+.. code-block:: bash
+
+    python setup.py install
+
+or
+
+.. code-block:: bash
+
+    pip install .
diff --git a/docs/figures/J1453-6413_simple_power_law_fit.png b/docs/figures/J1453-6413_simple_power_law_fit.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -7,8 +7,10 @@ Welcome to pulsar_spectra's documentation!
 ==========================================
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :caption: Contents:
    :glob:
 
+   installation
+   examples
    modules
diff --git a/docs/modules.rst b/docs/modules.rst
@@ -4,24 +4,24 @@
 
    <br />
 
-=======================
+**************************************
 pulsar\_spectra modules
-=======================
+**************************************
 
 catalogues
-----------
+==========
 
 .. automodule:: pulsar_spectra.catalogues
     :members:
 
 models
-------
+======
 
 .. automodule:: pulsar_spectra.models
     :members:
 
 spectral_fit
-------------
+============
 
 .. automodule:: pulsar_spectra.spectral_fit
     :members: