From refs/heads/main 76388ef

thallor1 · May 21, 2024 · 0b81dd2 · 0b81dd2
commit 0b81dd2
Show file tree

Hide file tree

Showing 100 changed files with 21,995 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 5993abf97064783c1dc3ce302cd8c7e2
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.nojekyll b/.nojekyll
diff --git a/README.md b/README.md
@@ -0,0 +1,3 @@
+#GitHub Pages
+
+Last update of sphinx html documentation from [76388ef](https://github.com/thallor1/pyMACS/tree/76388ef48fc0a29e15189498029fd797695daf10)
diff --git a/_images/notebooks_cri3_plotting_example_3_1.png b/_images/notebooks_cri3_plotting_example_3_1.png
diff --git a/_images/notebooks_cri3_plotting_example_5_0.png b/_images/notebooks_cri3_plotting_example_5_0.png
diff --git a/_images/notebooks_cri3_plotting_example_7_1.png b/_images/notebooks_cri3_plotting_example_7_1.png
diff --git a/_images/notebooks_cri3_plotting_example_9_1.png b/_images/notebooks_cri3_plotting_example_9_1.png
diff --git a/_images/notebooks_emulate_MACS_data_7_1.png b/_images/notebooks_emulate_MACS_data_7_1.png
diff --git a/_images/notebooks_introduction_notebook_21_1.png b/_images/notebooks_introduction_notebook_21_1.png
diff --git a/_images/notebooks_introduction_notebook_24_1.png b/_images/notebooks_introduction_notebook_24_1.png
diff --git a/_images/notebooks_resolution_example_3_1.png b/_images/notebooks_resolution_example_3_1.png
diff --git a/_images/notebooks_tio2_111_6_2.png b/_images/notebooks_tio2_111_6_2.png
diff --git a/_sources/api.rst.txt b/_sources/api.rst.txt
@@ -0,0 +1,8 @@
+API Reference
+-------------
+
+.. toctree::
+    :glob:
+    :maxdepth: 1
+
+
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -0,0 +1,50 @@
+.. pyMACS documentation master file, created by
+   sphinx-quickstart on Fri May 10 17:02:58 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to pyMACS's documentation!
+==================================
+
+**pyMACS** is a python interface to a mcStas simulation of the MACS instrument. 
+There are a few steps to get the package running, but most importantly this must be run on a *unix machine with a bash shell*. See :doc:`installation` for further information.
+
+.. note::
+
+   This project is not under active development and is experimental.
+
+
+
+Installation
+-----------------
+
+.. toctree::
+   installation
+
+
+.. raw:: html
+
+   <hr>
+
+Notebook Tutorials
+-------------------
+
+.. toctree::
+   notebooks/introduction_notebook
+   notebooks/emulate_MACS_data
+   notebooks/resolution_example
+   notebooks/tio2_111
+   notebooks/sqw4_simulation
+   notebooks/cri3_plotting_example
+
+Classes and Methods
+-------------------
+
+.. toctree::
+   virtualMACS
+   sample
+   kidney
+   monochromator
+   macsdata
+   scripting
+
diff --git a/_sources/installation.rst.txt b/_sources/installation.rst.txt
@@ -0,0 +1,13 @@
+Installation
+=======================
+
+Install with *pip*
+----------------------
+
+To use pyMACS, simply install using pip:
+
+.. code-block:: console
+
+	(base) $ install git+https://github.com/thallor1/pyMACS
+
+You will need to have a valid git installation first. 
diff --git a/_sources/kidney.rst.txt b/_sources/kidney.rst.txt
@@ -0,0 +1,11 @@
+kidney
+-------------------
+
+
+This is a python object that is the main wrapper for all of the methods of pyMACS. It requires only a few details to initialize - a .cif file to specify the sample being simulated, and a few instrumental settings. 
+
+.. autoclass:: pyMACS.kidney.Kidney
+	:members:
+	:show-inheritance:
+
+Create a list of object parameters, like n_mono.
diff --git a/_sources/macsdata.rst.txt b/_sources/macsdata.rst.txt
@@ -0,0 +1,11 @@
+macsdata
+-------------------
+
+
+This is a python object that is the main wrapper for all of the methods of pyMACS. It requires only a few details to initialize - a .cif file to specify the sample being simulated, and a few instrumental settings. 
+
+.. autoclass:: pyMACS.macsdata.Data
+	:members:
+	:show-inheritance:
+
+Create a list of object parameters, like n_mono.
diff --git a/_sources/modules.rst.txt b/_sources/modules.rst.txt
@@ -0,0 +1,7 @@
+pyMACS
+======
+
+.. toctree::
+   :maxdepth: 4
+
+   pyMACS
diff --git a/_sources/monochromator.rst.txt b/_sources/monochromator.rst.txt
@@ -0,0 +1,11 @@
+monochromator
+-------------------
+
+
+This is a python object that is the main wrapper for all of the methods of pyMACS. It requires only a few details to initialize - a .cif file to specify the sample being simulated, and a few instrumental settings. 
+
+.. autoclass:: pyMACS.monochromator.Monochromator
+	:members:
+	:show-inheritance:
+
+Create a list of object parameters, like n_mono.
diff --git a/_sources/notebooks/cri3_plotting_example.ipynb.txt b/_sources/notebooks/cri3_plotting_example.ipynb.txt
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		#GitHub Pages

		Last update of sphinx html documentation from [76388ef](https://github.com/thallor1/pyMACS/tree/76388ef48fc0a29e15189498029fd797695daf10)