diff --git a/docs/.nojekyll b/docs/.nojekyll deleted file mode 100644 index e69de29..0000000 diff --git a/docs/CMM.pipeline.rst b/docs/CMM.pipeline.rst deleted file mode 100644 index b5f6c23..0000000 --- a/docs/CMM.pipeline.rst +++ /dev/null @@ -1,7 +0,0 @@ -CMM.pipeline module -=================== - -.. automodule:: CMM.pipeline - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/CMM.preset.preset_.rst b/docs/CMM.preset.preset_.rst deleted file mode 100644 index 7bfe725..0000000 --- a/docs/CMM.preset.preset_.rst +++ /dev/null @@ -1,7 +0,0 @@ -CMM.preset.preset\_ module -========================== - -.. automodule:: CMM.preset.preset_ - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/CMM.preset.preset_acquisition.rst b/docs/CMM.preset.preset_acquisition.rst deleted file mode 100644 index acef6ee..0000000 --- a/docs/CMM.preset.preset_acquisition.rst +++ /dev/null @@ -1,7 +0,0 @@ -CMM.preset.preset\_acquisition module -===================================== - -.. automodule:: CMM.preset.preset_acquisition - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/CMM.preset.preset_components.rst b/docs/CMM.preset.preset_components.rst deleted file mode 100644 index aad9f00..0000000 --- a/docs/CMM.preset.preset_components.rst +++ /dev/null @@ -1,7 +0,0 @@ -CMM.preset.preset\_components module -==================================== - -.. automodule:: CMM.preset.preset_components - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/CMM.preset.preset_external_data.rst b/docs/CMM.preset.preset_external_data.rst deleted file mode 100644 index d03f709..0000000 --- a/docs/CMM.preset.preset_external_data.rst +++ /dev/null @@ -1,7 +0,0 @@ -CMM.preset.preset\_external\_data module -======================================== - -.. automodule:: CMM.preset.preset_external_data - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/CMM.preset.preset_gain.rst b/docs/CMM.preset.preset_gain.rst deleted file mode 100644 index c72878f..0000000 --- a/docs/CMM.preset.preset_gain.rst +++ /dev/null @@ -1,7 +0,0 @@ -CMM.preset.preset\_gain module -============================== - -.. automodule:: CMM.preset.preset_gain - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/CMM.preset.preset_mixingmatrix.rst b/docs/CMM.preset.preset_mixingmatrix.rst deleted file mode 100644 index 4a61e45..0000000 --- a/docs/CMM.preset.preset_mixingmatrix.rst +++ /dev/null @@ -1,7 +0,0 @@ -CMM.preset.preset\_mixingmatrix module -====================================== - -.. automodule:: CMM.preset.preset_mixingmatrix - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/CMM.preset.preset_qubic.rst b/docs/CMM.preset.preset_qubic.rst deleted file mode 100644 index d6438b2..0000000 --- a/docs/CMM.preset.preset_qubic.rst +++ /dev/null @@ -1,7 +0,0 @@ -CMM.preset.preset\_qubic module -=============================== - -.. automodule:: CMM.preset.preset_qubic - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/CMM.preset.preset_sky.rst b/docs/CMM.preset.preset_sky.rst deleted file mode 100644 index ec81404..0000000 --- a/docs/CMM.preset.preset_sky.rst +++ /dev/null @@ -1,7 +0,0 @@ -CMM.preset.preset\_sky module -============================= - -.. automodule:: CMM.preset.preset_sky - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/CMM.preset.preset_tools.rst b/docs/CMM.preset.preset_tools.rst deleted file mode 100644 index 7d2a7f5..0000000 --- a/docs/CMM.preset.preset_tools.rst +++ /dev/null @@ -1,7 +0,0 @@ -CMM.preset.preset\_tools module -=============================== - -.. automodule:: CMM.preset.preset_tools - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/CMM.preset.rst b/docs/CMM.preset.rst deleted file mode 100644 index ea75d5a..0000000 --- a/docs/CMM.preset.rst +++ /dev/null @@ -1,23 +0,0 @@ -CMM.preset package -================== - -.. automodule:: CMM.preset - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - CMM.preset.preset_ - CMM.preset.preset_acquisition - CMM.preset.preset_components - CMM.preset.preset_external_data - CMM.preset.preset_gain - CMM.preset.preset_mixingmatrix - CMM.preset.preset_qubic - CMM.preset.preset_sky - CMM.preset.preset_tools diff --git a/docs/CMM.rst b/docs/CMM.rst deleted file mode 100644 index fbc37a3..0000000 --- a/docs/CMM.rst +++ /dev/null @@ -1,23 +0,0 @@ -CMM package -=========== - -.. automodule:: CMM - :members: - :undoc-members: - :show-inheritance: - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - CMM.preset - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - CMM.pipeline diff --git a/docs/FMM.main.rst b/docs/FMM.main.rst deleted file mode 100644 index a1005ac..0000000 --- a/docs/FMM.main.rst +++ /dev/null @@ -1,7 +0,0 @@ -FMM.main module -=============== - -.. automodule:: FMM.main - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/FMM.pipeline.rst b/docs/FMM.pipeline.rst deleted file mode 100644 index 1d32d07..0000000 --- a/docs/FMM.pipeline.rst +++ /dev/null @@ -1,7 +0,0 @@ -FMM.pipeline module -=================== - -.. automodule:: FMM.pipeline - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/FMM.rst b/docs/FMM.rst deleted file mode 100644 index becfcca..0000000 --- a/docs/FMM.rst +++ /dev/null @@ -1,16 +0,0 @@ -FMM package -=========== - -.. automodule:: FMM - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - FMM.main - FMM.pipeline diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index d4bb2cb..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -SOURCEDIR = . -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) diff --git a/docs/_build/doctrees/CMM.doctree b/docs/_build/doctrees/CMM.doctree deleted file mode 100644 index b0f5825..0000000 Binary files a/docs/_build/doctrees/CMM.doctree and /dev/null differ diff --git a/docs/_build/doctrees/CMM.pipeline.doctree b/docs/_build/doctrees/CMM.pipeline.doctree deleted file mode 100644 index bc4f4e1..0000000 Binary files a/docs/_build/doctrees/CMM.pipeline.doctree and /dev/null differ diff --git a/docs/_build/doctrees/CMM.preset.doctree b/docs/_build/doctrees/CMM.preset.doctree deleted file mode 100644 index 4d86174..0000000 Binary files a/docs/_build/doctrees/CMM.preset.doctree and /dev/null differ diff --git a/docs/_build/doctrees/CMM.preset.preset_.doctree b/docs/_build/doctrees/CMM.preset.preset_.doctree deleted file mode 100644 index 18c8aa9..0000000 Binary files a/docs/_build/doctrees/CMM.preset.preset_.doctree and /dev/null differ diff --git a/docs/_build/doctrees/CMM.preset.preset_acquisition.doctree b/docs/_build/doctrees/CMM.preset.preset_acquisition.doctree deleted file mode 100644 index 29dd986..0000000 Binary files a/docs/_build/doctrees/CMM.preset.preset_acquisition.doctree and /dev/null differ diff --git a/docs/_build/doctrees/CMM.preset.preset_components.doctree b/docs/_build/doctrees/CMM.preset.preset_components.doctree deleted file mode 100644 index e256b5c..0000000 Binary files a/docs/_build/doctrees/CMM.preset.preset_components.doctree and /dev/null differ diff --git a/docs/_build/doctrees/CMM.preset.preset_external_data.doctree b/docs/_build/doctrees/CMM.preset.preset_external_data.doctree deleted file mode 100644 index 4ef3577..0000000 Binary files a/docs/_build/doctrees/CMM.preset.preset_external_data.doctree and /dev/null differ diff --git a/docs/_build/doctrees/CMM.preset.preset_gain.doctree b/docs/_build/doctrees/CMM.preset.preset_gain.doctree deleted file mode 100644 index 0f37ea1..0000000 Binary files a/docs/_build/doctrees/CMM.preset.preset_gain.doctree and /dev/null differ diff --git a/docs/_build/doctrees/CMM.preset.preset_mixingmatrix.doctree b/docs/_build/doctrees/CMM.preset.preset_mixingmatrix.doctree deleted file mode 100644 index 359343b..0000000 Binary files a/docs/_build/doctrees/CMM.preset.preset_mixingmatrix.doctree and /dev/null differ diff --git a/docs/_build/doctrees/CMM.preset.preset_qubic.doctree b/docs/_build/doctrees/CMM.preset.preset_qubic.doctree deleted file mode 100644 index e7492e8..0000000 Binary files a/docs/_build/doctrees/CMM.preset.preset_qubic.doctree and /dev/null differ diff --git a/docs/_build/doctrees/CMM.preset.preset_sky.doctree b/docs/_build/doctrees/CMM.preset.preset_sky.doctree deleted file mode 100644 index 4b7a65f..0000000 Binary files a/docs/_build/doctrees/CMM.preset.preset_sky.doctree and /dev/null differ diff --git a/docs/_build/doctrees/CMM.preset.preset_tools.doctree b/docs/_build/doctrees/CMM.preset.preset_tools.doctree deleted file mode 100644 index 52bdaef..0000000 Binary files a/docs/_build/doctrees/CMM.preset.preset_tools.doctree and /dev/null differ diff --git a/docs/_build/doctrees/FMM.doctree b/docs/_build/doctrees/FMM.doctree deleted file mode 100644 index 4206b2f..0000000 Binary files a/docs/_build/doctrees/FMM.doctree and /dev/null differ diff --git a/docs/_build/doctrees/FMM.main.doctree b/docs/_build/doctrees/FMM.main.doctree deleted file mode 100644 index 110cbc6..0000000 Binary files a/docs/_build/doctrees/FMM.main.doctree and /dev/null differ diff --git a/docs/_build/doctrees/FMM.pipeline.doctree b/docs/_build/doctrees/FMM.pipeline.doctree deleted file mode 100644 index ff5b13c..0000000 Binary files a/docs/_build/doctrees/FMM.pipeline.doctree and /dev/null differ diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle deleted file mode 100644 index 07ea8b9..0000000 Binary files a/docs/_build/doctrees/environment.pickle and /dev/null differ diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree deleted file mode 100644 index 7348bb7..0000000 Binary files a/docs/_build/doctrees/index.doctree and /dev/null differ diff --git a/docs/_build/doctrees/modules.doctree b/docs/_build/doctrees/modules.doctree deleted file mode 100644 index 51f4c02..0000000 Binary files a/docs/_build/doctrees/modules.doctree and /dev/null differ diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo deleted file mode 100644 index 7ead4a1..0000000 --- a/docs/_build/html/.buildinfo +++ /dev/null @@ -1,4 +0,0 @@ -# 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: 0d6811bd6709feaeca229028a861418f -tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/_build/html/.nojekyll b/docs/_build/html/.nojekyll deleted file mode 100644 index e69de29..0000000 diff --git a/docs/_build/html/CMM.html b/docs/_build/html/CMM.html deleted file mode 100644 index 7ac5ffa..0000000 --- a/docs/_build/html/CMM.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - - - - CMM package — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- - -
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/CMM.pipeline.html b/docs/_build/html/CMM.pipeline.html deleted file mode 100644 index e876618..0000000 --- a/docs/_build/html/CMM.pipeline.html +++ /dev/null @@ -1,395 +0,0 @@ - - - - - - - CMM.pipeline module — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

CMM.pipeline module

-
-
-class CMM.pipeline.Pipeline(comm, seed, seed_noise=None)[source]
-

Bases: object

-

Instance to reconstruct component maps using QUBIC abilities.

-
-
Parameters:
-
    -
  • comm (MPI communicator) – MPI common communicator define by MPI.COMM_WORLD.

  • -
  • seed (int) – Seed for random CMB realization.

  • -
  • seed_noise (int, optional) – Seed for random noise realization, by default None.

  • -
-
-
-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

call_pcg(max_iterations, seenpix)

Precontioned Conjugate Gradiant algorithm.

callback(x)

Callback for scipy.minimize.

fisher(ell, Nl)

Fisher Method.

fisher_compute_sigma_r()

Fisher estimation.

get_constrains()

Constraints for scipy.minimize.

get_tod_comp()

Component TOD.

give_intercal(D, d, _invn)

Detectors intercalibration.

main()

Pipeline.

update_components(seenpix)

Method that solves the map-making equation :math:`(H^T .

update_gain()

Update detectors gain.

update_mixing_matrix(beta, ...)

Update Mixing Matrix.

update_spectral_index()

Update spectral index.

- - - - - - - - - -

get_tod_comp_superpixel

save_data

-
-
-call_pcg(max_iterations, seenpix)[source]
-

Precontioned Conjugate Gradiant algorithm.

-

Method to call the PCG from PyOperators package.

-
-
Parameters:
-
    -
  • max_iterations (int) – Maximum number of iterations for the PCG algorithm.

  • -
  • seenpix (array_like) – Boolean array that define the pixels observed by QUBIC.

  • -
-
-
-
- -
-
-callback(x)[source]
-

Callback for scipy.minimize.

-

Method to make callback function readable by scipy.optimize.minimize.

-

This method is intended to be used as a callback function during the optimization -process. It is called by the optimizer at each iteration.

-

The method performs the following actions: -1. Synchronizes all processes using a barrier to ensure that all processes reach this point before proceeding. -2. If the current process is the root process (rank 0), it performs the following:

-
-
    -
  1. Every 5 iterations (when self.nfev is a multiple of 5), it prints the current iteration number and the parameter values rounded to 5 decimal places.

  2. -
-
-
    -
  1. Increments the iteration counter self.nfev by 1.

  2. -
-
-
Parameters:
-

x (array_like) – The current parameter values at the current iteration of the optimization.

-
-
-
- -
-
-fisher(ell, Nl)[source]
-

Fisher Method.

-

Fisher to compute an estimation of sigma(r) for a given noise power spectrum.

-
-
Parameters:
-
    -
  • ell (array_like) – Array containing the multipole values.

  • -
  • Nl (array_like) – Array containing the noise power spectrum values.

  • -
-
-
Returns:
-

sigma – Estimated value of sigma(r).

-
-
Return type:
-

float

-
-
-
- -
-
-fisher_compute_sigma_r()[source]
-

Fisher estimation.

-

Computes and prints the value of sigma(r) using the Fisher matrix.

-
- -
-
-get_constrains()[source]
-

Constraints for scipy.minimize.

-

Generate constraints readable by scipy.optimize.minimize.

-
-
Returns:
-

constraints – A list of constraint dictionaries for optimize.minimize.

-
-
Return type:
-

list

-
-
-
- -
-
-get_tod_comp()[source]
-

Component TOD.

-

Method that produces Time-Ordered Data (TOD) using the component maps computed at the current iteration.

-

This method initializes a zero-filled numpy array tod_comp with dimensions based on the number of components, -the number of sub-components (multiplied by 2), and the product of the number of detectors and samples. -It then iterates over each component and sub-component to compute the TOD by applying a convolution operator -(if specified) and a mapping operator to the component maps.

-
-
Returns:
-

tod_comp – A numpy array containing the computed TOD for each component and sub-component.

-
-
Return type:
-

array_like

-
-
-
- -
-
-get_tod_comp_superpixel(index)[source]
-
- -
-
-give_intercal(D, d, _invn)[source]
-

Detectors intercalibration.

-

Semi-analytical method for gains estimation. (cf CMM paper)

-
-
Parameters:
-
    -
  • D (array_like) – Simlulated data, given by the formula : \(\vec{D} = H.A.\vec{c}\), -where H is the pointing matrix, A the mixing matrix and c the component vector.

  • -
  • d (array_like) – Observed data, given by the formula : \(\vec{d} = G.\vec{D} + \vec{n}\), -where G is the detectors’ intercalibration matrix and n the noise vector.

  • -
  • _invn (Diagonal Operator) – Inverse noise covariance matrix.

  • -
-
-
Returns:
-

g – Intercalibration vector.

-
-
Return type:
-

array_like

-
-
-
- -
-
-main()[source]
-

Pipeline.

-

Method to run the pipeline by following :

-
-
    -
  1. Initialize simulation using PresetSims instance reading params.yml.

  2. -
  3. Solve map-making equation knowing spectral index and gains.

  4. -
  5. Fit spectral index knowing components and gains.

  6. -
  7. Fit gains knowing components and sepctral index.

  8. -
  9. Repeat 2), 3) and 4) until convergence.

  10. -
-
-
- -
-
-save_data(step)[source]
-
- -
-
-update_components(seenpix)[source]
-

Method that solves the map-making equation \((H^T . N^{-1} . H) . x = H^T . N^{-1} . d\), using OpenMP / MPI solver.

-

This method updates the components of the map by solving the map-making equation using an OpenMP / MPI solver. -The equation is of the form \((H^T . N^{-1} . H) . \vec{c} = H^T . N^{-1} . \vec{TOD}\), where H_i is the operator obtained from the preset, -U is a reshaped operator, and x_planck and xI are intermediate variables used in the calculations.

-
-
Parameters:
-

seenpix (array_like) – Boolean array that define the pixels observed by QUBIC.

-
-
-
- -
-
-update_gain()[source]
-

Update detectors gain.

-

Method that compute and print gains of each detectors using semi-analytical method decribed in “give_intercal” function, -using the formula : \(g^i = \frac{TOD_{obs}^i}{TOD_{sim}^i}\).

-
- -
-
-update_mixing_matrix(beta, previous_mixingmatrix, icomp)[source]
-

Update Mixing Matrix.

-

Method to update the mixing matrix using the current fitted value of the beta parameter and the parametric model associated. -Only use when hybrid parametric-blind fit is selected !

-
-
Parameters:
-
    -
  • beta (int) – Spectral index.

  • -
  • previous_mixingmatrix (array_like) – Mixing Matrix at the previous iteration \((N_{sub} + N_{integr} . N_{Planck}, N_{comp})\).

  • -
  • icomp (int) – Component index.

  • -
-
-
Returns:
-

updated_mixingmatrix – The updated Mixing Matrix.

-
-
Return type:
-

array_like

-
-
-
- -
-
-update_spectral_index()[source]
-

Update spectral index.

-

Method that perform step 3) of the pipeline for 2 possible designs : Two Bands and Ultra Wide Band

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/CMM.preset.html b/docs/_build/html/CMM.preset.html deleted file mode 100644 index 547520d..0000000 --- a/docs/_build/html/CMM.preset.html +++ /dev/null @@ -1,293 +0,0 @@ - - - - - - - CMM.preset package — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

CMM.preset package

-
-
-class CMM.preset.PresetInitialisation(comm, seed, seed_noise)[source]
-

Bases: object

-

Preset initialization.

-

Instance to initialize the Components Map-Making reading all the preset files.

-
-
Parameters:
-
    -
  • comm (MPI communicator) – MPI common communicator (define by MPI.COMM_WORLD).

  • -
  • seed (int) – Seed for random CMB realization.

  • -
  • seed_noise (int) – Seed for random noise realization.

  • -
-
-
-

Methods

- - - - - - -

initialize()

Initialization.

-
-
-initialize()[source]
-

Initialization.

-

Method that initialize and return all the preset instances that will be used in Component Map-Making Pipeline.

-
- -
- -
-

Submodules

-
- -
-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/CMM.preset.preset_.html b/docs/_build/html/CMM.preset.preset_.html deleted file mode 100644 index 802320f..0000000 --- a/docs/_build/html/CMM.preset.preset_.html +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - CMM.preset.preset_ module — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

CMM.preset.preset_ module

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/CMM.preset.preset_acquisition.html b/docs/_build/html/CMM.preset.preset_acquisition.html deleted file mode 100644 index 827e795..0000000 --- a/docs/_build/html/CMM.preset.preset_acquisition.html +++ /dev/null @@ -1,486 +0,0 @@ - - - - - - - CMM.preset.preset_acquisition module — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

CMM.preset.preset_acquisition module

-
-
-class CMM.preset.preset_acquisition.PresetAcquisition(seed_noise, preset_tools, preset_external, preset_qubic, preset_sky, preset_comp, preset_mixing_matrix, preset_gain)[source]
-

Bases: object

-

Preset Acquisition.

-

Instance to initialize the Components Map-Making. It defines the data acquisition variables and methods.

-
-
Parameters:
-
    -
  • seed_noise (int) – Seed for random noise generation.

  • -
  • preset_tools (object) – Class containing tools and simulation parameters.

  • -
  • preset_external (object) – Class containing external variables and methods.

  • -
  • preset_qubic (object) – Class containing qubic operator and variables and methods.

  • -
  • preset_sky (object) – Class containing sky varaibles and methods.

  • -
  • preset_comp (object) – Class containing component variables and methods.

  • -
  • preset_mixing_matrix (object) – Class containing mixing-matrix variables and methods.

  • -
  • preset_gain (object) – Class containing detector gain variables and methods.

  • -
-
-
-
-
-seed_noise
-

Seed for random noise realization.

-
-
Type:
-

int

-
-
-
- -
-
-params_foregrounds
-

Dictionary containing the paramters associated with foregrounds.

-
-
Type:
-

dict

-
-
-
- -
-
-rms_tolerance
-

Tolerance for PCG algorithm.

-
-
Type:
-

float

-
-
-
- -
-
-ites_to_converge
-

Max iteration number for PCG algorithm.

-
-
Type:
-

int

-
-
-
- -
-
-invN
-

Inverse noise covariance matrix with input shape \((N_{det}*N_{samples} + N_{pix}*N_{planck}*N_{stokes})\) and output shape \((N_{det}*N_{samples} + N_{pix}*N_{planck}*N_{stokes})\).

-
-
Type:
-

BlockDiagonalOperator

-
-
-
- -
-
-M
-

Preconditioner for PCG algorithm.

-
-
Type:
-

DiagonalOperator

-
-
-
- -
-
-fwhm_rec
-

Resolution of the reconstructed maps.

-
-
Type:
-

array_like

-
-
-
- -
-
-H
-

Pointing matrix.

-
-
Type:
-

BlockColumnOperator

-
-
-
- -
-
-TOD_qubic
-

QUBIC simulated TOD.

-
-
Type:
-

array_like

-
-
-
- -
-
-TOD_external
-

Planck simulated TOD.

-
-
Type:
-

array_like

-
-
-
- -
-
-TOD_obs
-

Simulated observed TOD.

-
-
Type:
-

array_like

-
-
-
- -
-
-beta_iter
-

Spectral indices, if d1 \((12 \times Nside_{\beta}^2, N_{comp}-1)\), if not \((N_{comp}-1)\).

-
-
Type:
-

array_like

-
-
-
- -
-
-allbeta
-

Spectral indeices, if d1 \((iter, 12 \times Nside_{\beta}^2, N_{comp}-1)\), if not \((iter, N_{comp}-1)\).

-
-
Type:
-

array_like

-
-
-
- -
-
-Amm_iter
-

Mixing matrix.

-
-
Type:
-

array_like

-
-
-
- -

Methods

- - - - - - - - - - - - - - - - - - - - - -

get_approx_hth()

Approx HTH.

get_convolution()

Convolutions.

get_noise()

Noise.

get_preconditioner(A_qubic, A_ext[, ...])

Preconditioner for PCG algorithm.

get_tod()

TOD.

get_x0()

PCG starting point.

-
-
-get_approx_hth()[source]
-

Approx HTH.

-

Calculates the approximation of \(H^T.H\).

-
-
Returns:
-

    -
  • approx_hth (array_like) – The approximation of \(H^T.H\) with shape \((N_{sub}^{in}, N_{pixel}, 3)\).

  • -
  • approx_hth_ext (array_like) – The approximation of \(H^T.H\) for Planck.

  • -
-

-
-
-
- -
-
-get_convolution()[source]
-

Convolutions.

-

Method to define all angular resolutions of the instrument at each frequency.

-

This method sets the Full Width at Half Maximum (FWHM) for Time-Ordered Data (TOD) and map-making processes. -self.fwhm_tod represents the real angular resolution, and self.fwhm_mapmaking represents the beams used for reconstruction.

-

The method checks the convolution_in and convolution_out parameters to determine the appropriate FWHM values. -It also calculates the reconstructed FWHM based on these parameters.

-
-
Returns:
-

    -
  • fwhm_tod (array_like) – Resolutions to create input TOD.

  • -
  • fwhm_mapmaking (array_like) – Resolutions for map-making.

  • -
  • fwhm_rec (array_like) – Resolutions of reconstructed maps.

  • -
-

-
-
-
- -
-
-get_noise()[source]
-

Noise.

-

Method to define QUBIC noise, can generate Dual band or Wide Band noise by following:

-
    -
  • Dual Band: n = [Ndet + Npho_150, Ndet + Npho_220]

  • -
  • Wide Band: n = [Ndet + Npho_150 + Npho_220]

  • -
-

Depending on the instrument type specified in the preset_qubic parameters, this method will -instantiate either QubicWideBandNoise or QubicDualBandNoise and return the total noise.

-
-
Returns:
-

noise – The total noise array, flattened.

-
-
Return type:
-

array_like

-
-
-
- -
-
-get_preconditioner(A_qubic, A_ext, precond=True, thr=0)[source]
-

Preconditioner for PCG algorithm.

-

Calculates and returns the preconditioner matrix for the optimization process.

-
-
Parameters:
-
    -
  • A_qubic (array_like) – QUBIC mixing matrix.

  • -
  • A_ext (array_like) – Planck mixing matrix.

  • -
  • precond (bool, optional) – Tells if you want a precontioner or not, by default True

  • -
  • thr (int, optional) – Threshold to define the pixels seen by QUBIC, by default 0

  • -
-
-
Returns:
-

M – Preconditioner for PCG algorithm.

-
-
Return type:
-

DiagonalOperator

-
-
-
- -
-
-get_tod()[source]
-

TOD.

-

Generate fake observational data from QUBIC and external experiments.

-

This method simulates observational data, including astrophysical foregrounds contamination using self.beta and systematics using self.g. -The data generation follows the formula: \(\vec{d} = H.A.\vec{c} + \vec{n}\).

-
-
-H
-

Pointing matrix operator.

-
-
Type:
-

Operator

-
-
-
- -
-
-TOD_qubic
-

The simulated observational data for QUBIC.

-
-
Type:
-

array_like

-
-
-
- -
-
-TOD_external
-

The simulated observational data for external experiments.

-
-
Type:
-

array_like

-
-
-
- -
-
-TOD_obs
-

The combined observational data from QUBIC and external experiments.

-
-
Type:
-

array_like

-
-
-
- -
-
-nsampling_x_ndetectors
-

The number of samples in self.TOD_qubic.

-
-
Type:
-

int

-
-
-
- -
- -
-
-get_x0()[source]
-

PCG starting point.

-

Define starting point of the convergence.

-

The argument ‘set_comp_to_0’ multiplies the pixel values by a given factor. You can decide -to convolve the map by a beam with an FWHM in radians.

-

This method initializes the beta_iter and Amm_iter attributes based on the foreground model parameters. -It also applies convolution and noise to the components based on the preset parameters.

-
-
Raises:
-

TypeError – If an unrecognized component name is encountered.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/CMM.preset.preset_components.html b/docs/_build/html/CMM.preset.preset_components.html deleted file mode 100644 index 9266102..0000000 --- a/docs/_build/html/CMM.preset.preset_components.html +++ /dev/null @@ -1,359 +0,0 @@ - - - - - - - CMM.preset.preset_components module — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

CMM.preset.preset_components module

-
-
-class CMM.preset.preset_components.PresetComponents(preset_tools, preset_qubic, seed)[source]
-

Bases: object

-

Preset Components.

-

Instance to initialize the Components Map-Making. It defines the Foregrounds variables and methods.

-
-
Parameters:
-
    -
  • seed_noise (int) – Seed for random CMB noise generation.

  • -
  • preset_tools (object) – Class containing tools and simulation parameters.

  • -
  • preset_qubic (object) – Class containing qubic operator and variables and methods.

  • -
-
-
-
-
-params_cmb
-

Dictionary containing the parameters associated with CMB.

-
-
Type:
-

dict

-
-
-
- -
-
-params_foregrounds
-

Dictionary containing the parameters associated with foregrounds.

-
-
Type:
-

dict

-
-
-
- -
-
-seed
-

Seed for random CMB noise generation.

-
-
Type:
-

int

-
-
-
- -
-
-skyconfig
-

Dictionary containing the wanted sky configuration for PySM.

-
-
Type:
-

dict

-
-
-
- -
-
-components_model
-

List containing the FGBuster instance relative to the wanted components.

-
-
Type:
-

list

-
-
-
- -
-
-components_name
-

List containing the name of the components.

-
-
Type:
-

list

-
-
-
- -
-
-components
-

Components maps according to chosen model.

-
-
Type:
-

array_like

-
-
-
- -
-
-components_convolved
-

Convolved components maps.

-
-
Type:
-

array_like

-
-
-
- -
-
-components_iter
-

Initilize array on which we will iterate to reconstruct components maps.

-
-
Type:
-

array_like

-
-
-
- -
-
-nu_co
-

Frequency of the monochromatic emission, None if not chosen.

-
-
Type:
-

int

-
-
-
- -

Methods

- - - - - - - - - - - - - - - -

get_components(skyconfig)

Components maps.

get_sky_config(key)

Sky configuration.

give_cl_cmb([r, Alens])

\(C_{\ell}^{BB}\) CMB.

polarized_I(m, nside[, polarization_fraction])

Polarized intensity map.

-
-
-get_components(skyconfig)[source]
-

Components maps.

-

Read configuration dictionary which contains every compoenent and their associated model. -The CMB is randomly generated from a specific seed. -Astrophysical foregrounds come from PySM 3.

-
-
Parameters:
-

skyconfig (dict) – Dictionary containing the configuration for each component.

-
-
Returns:
-

    -
  • components (array_like) – Components maps according to chosen model.

  • -
  • components_convolved (array_like) – Convolved components maps.

  • -
  • components_iter (array_like) – Initilize array on which we will iterate to reconstruct components maps.

  • -
-

-
-
Raises:
-

TypeError – Raises if the chosen model does not exist.

-
-
-
- -
-
-get_sky_config(key)[source]
-

Sky configuration.

-

Method to define the sky model used by PySM3 to generate a fake sky.

-
-
Parameters:
-

key (str) – The key to access the specific parameters in the prest configuration. -Can be either “in” or “out”.

-
-
Returns:
-

skyconfig – Dictionary containing the sky model configuration.

-
-
Return type:
-

dict

-
-
-

Example

-

sky = {‘cmb’: 42, ‘Dust’: ‘d0’}

-
- -
-
-give_cl_cmb(r=0, Alens=1.0)[source]
-

\(C_{\ell}^{BB}\) CMB.

-

Generates the CMB BB power spectrum with optional lensing and tensor contributions.

-
-
Parameters:
-
    -
  • r (int, optional) – Tensor-to-scalar ratio, by default 0

  • -
  • Alens (float, optional) – Lensing amplitude, by default 1.0

  • -
-
-
Returns:
-

power_spectrum – CMB power spectrum according to r and Alens.

-
-
Return type:
-

array_like

-
-
-
- -
-
-polarized_I(m, nside, polarization_fraction=0)[source]
-

Polarized intensity map.

-

Calculates the polarized intensity map.

-
-
Parameters:
-
    -
  • m (array_like) – Input map to be polarised

  • -
  • nside (int) – Nside parameter of the HEALPix map.

  • -
  • polarization_fraction (float, optional) – Fraction of polarization, by default 0

  • -
-
-
Returns:
-

p_map – Array containing the polarized intensity map with cosine and sine components.

-
-
Return type:
-

array_like

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/CMM.preset.preset_external_data.html b/docs/_build/html/CMM.preset.preset_external_data.html deleted file mode 100644 index 66290c5..0000000 --- a/docs/_build/html/CMM.preset.preset_external_data.html +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - - CMM.preset.preset_external_data module — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

CMM.preset.preset_external_data module

-
-
-class CMM.preset.preset_external_data.PresetExternal(preset_tools)[source]
-

Bases: object

-

Preset External Data.

-

Instance to initialize the Components Map-Making. It defines the external data variables and methods.

-
-
Parameters:
-

preset_tools (object) – Class containing tools and simulation parameters.

-
-
-
-
-external_nus
-

List containing Planck maps frequency.

-
-
Type:
-

list

-
-
-
- -

Methods

- - - - - - -

get_external_nus()

External frequencies.

-
-
-get_external_nus()[source]
-

External frequencies.

-

Method to create a Python list of external frequencies by reading the params.yml file.

-

This method reads the params.yml file and checks for the presence of specific frequency -values under the ‘PLANCK’ section. If a frequency is present, it is added to the external -frequencies list.

-
-
Returns:
-

external_nus – List containing Planck maps frequency.

-
-
Return type:
-

list

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/CMM.preset.preset_gain.html b/docs/_build/html/CMM.preset.preset_gain.html deleted file mode 100644 index 2ee5e67..0000000 --- a/docs/_build/html/CMM.preset.preset_gain.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - - CMM.preset.preset_gain module — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

CMM.preset.preset_gain module

-
-
-class CMM.preset.preset_gain.PresetGain(preset_tools, preset_qubic)[source]
-

Bases: object

-

Preset Detectors Gain.

-

Instance to initialize the Components Map-Making. It defines the input detectors gain variables and methodes.

-
-
Parameters:
-
    -
  • preset_tools (object) – Class containing tools and simulation parameters.

  • -
  • preset_qubic (object) – Class containing qubic operator and variables and methods.

  • -
-
-
-

Methods

- - - - - - -

get_input_gain()

Input gains.

-
-
-get_input_gain()[source]
-

Input gains.

-

Generates and processes input gain values for the instrument based on preset parameters.

-

This method sets the gain_in, all_gain_in, gain_iter, all_gain, and all_gain_iter -attributes of the instance. The gain values are generated using a normal distribution and may be -adjusted based on the instrument type and preset parameters.

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/CMM.preset.preset_mixingmatrix.html b/docs/_build/html/CMM.preset.preset_mixingmatrix.html deleted file mode 100644 index a55c5e5..0000000 --- a/docs/_build/html/CMM.preset.preset_mixingmatrix.html +++ /dev/null @@ -1,383 +0,0 @@ - - - - - - - CMM.preset.preset_mixingmatrix module — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

CMM.preset.preset_mixingmatrix module

-
-
-class CMM.preset.preset_mixingmatrix.PresetMixingMatrix(preset_tools, preset_qubic, preset_comp)[source]
-

Bases: object

-

Preset Mixing Matrix.

-

Instance to initialize the Components Map-Making. It defines Mixing Matrix variables and methodes.

-
-
Parameters:
-
    -
  • preset_tools (object) – Class containing tools and simulation parameters.

  • -
  • preset_qubic (object) – Class containing qubic operator and variables and methods.

  • -
  • preset_comp (object) – Class containing component variables and methods.

  • -
-
-
-
-
-nus_eff_in
-

Input effective frequencies.

-
-
Type:
-

array_like

-
-
-
- -
-
-nus_eff_out
-

Output effective frequencies.

-
-
Type:
-

array_like

-
-
-
- -
-
-Amm_in
-

Input mixing matrix.

-
-
Type:
-

array_like

-
-
-
- -
-
-beta_in
-

Input spectral indices.

-
-
Type:
-

array_like

-
-
-
- -

Methods

- - - - - - - - - - - - - - - - - - - - - - - - -

extra_sed(nus, correlation_length)

Spectral Energy Distribution.

get_beta_input()

Spectral index.

get_decorrelated_mixing_matrix(lcorr, seed)

Decorrelated mixing matrix.

get_index_seenpix_beta()

Spatially varying spectral index.

get_mixingmatrix(nus, beta[, key])

Mixing Matrix.

spectral_index_modifiedblackbody(nside)

ModifiedBlackBody spectral indices.

spectral_index_powerlaw(nside)

PowerLaw spectral indices.

-
-
-extra_sed(nus, correlation_length)[source]
-

Spectral Energy Distribution.

-

Calculates the extra SED (Spectral Energy Distribution) based on the given parameters.

-
-
Parameters:
-
    -
  • nus (array_like) – Array containing frequencies.

  • -
  • correlation_length (float) – The correlation lenght.

  • -
-
-
Returns:
-

extra – Array containing the extra SED values.

-
-
Return type:
-

array_like

-
-
-
- -
-
-get_beta_input()[source]
-

Spectral index.

-

Define the input spectral indices based on the model type.

-

If the model is ‘d0’ or ‘d6’, the input spectral index is fixed (1.54). -Otherwise, the model assumes varying spectral indices across the sky by calling the previous method. -In this case, the shape of beta is (Nbeta, Ncomp).

-
-
-nus_eff_in
-

Input effective frequencies.

-
-
Type:
-

array_like

-
-
-
- -
-
-nus_eff_out
-

Output effective frequencies.

-
-
Type:
-

array_like

-
-
-
- -
-
-Amm_in
-

Input mixing matrix.

-
-
Type:
-

array_like

-
-
-
- -
-
-beta_in
-

Input spectral indices.

-
-
Type:
-

array_like

-
-
-
- -
-
Raises:
-

TypeError – Raises if the chosen model is not implemented.

-
-
-
- -
-
-get_decorrelated_mixing_matrix(lcorr, seed, key='in')[source]
-

Decorrelated mixing matrix.

-
-
Parameters:
-
    -
  • lcorr (float) – Correlation lenght.

  • -
  • seed (int) – Seed for random decorrealtion.

  • -
  • key (str, optional) – The key to access the specific parameters in the prest configuration. -Can be either “in” or “out”, by default “in”

  • -
-
-
Returns:
-

Adeco – Decorrelated mixing matrix.

-
-
Return type:
-

array_like

-
-
-
- -
-
-get_index_seenpix_beta()[source]
-

Spatially varying spectral index.

-

Method to initialize index seenpix beta variable.

-
- -
-
-get_mixingmatrix(nus, beta, key='in')[source]
-

Mixing Matrix.

-

Method to get the mixing matrix from FGBuster according to compoenents model.

-
-
Parameters:
-
    -
  • nus (array_like) – Array containing frequencies.

  • -
  • beta (float) – Spectral index.

  • -
  • key (str, optional) – The key to access the specific parameters in the prest configuration. -Can be either “in” or “out”, by default “in”

  • -
-
-
Returns:
-

Amm – Mixing matrix.

-
-
Return type:
-

array_like

-
-
Raises:
-

ValueError – Raises in case of incorrect key.

-
-
-
- -
-
-spectral_index_modifiedblackbody(nside)[source]
-

ModifiedBlackBody spectral indices.

-

Method to define input spectral indices if the d1 model is used for thermal Dust description.

-
-
Parameters:
-

nside (int) – Nside parameter for HEALPix map.

-
-
Returns:
-

mbb_index – Array containing the spectral indices for the thermal Dust model.

-
-
Return type:
-

array_like

-
-
-
- -
-
-spectral_index_powerlaw(nside)[source]
-

PowerLaw spectral indices.

-

Define input spectral indices if the s1 model is used for Synchrotron description.

-
-
Parameters:
-

nside (int) – Nside parameter for HEALPix map.

-
-
Returns:
-

pl_index – Array containing the spectral indices for the Synchrotron model.

-
-
Return type:
-

array_like

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/CMM.preset.preset_qubic.html b/docs/_build/html/CMM.preset.preset_qubic.html deleted file mode 100644 index c17340c..0000000 --- a/docs/_build/html/CMM.preset.preset_qubic.html +++ /dev/null @@ -1,221 +0,0 @@ - - - - - - - CMM.preset.preset_qubic module — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

CMM.preset.preset_qubic module

-
-
-class CMM.preset.preset_qubic.PresetQubic(preset_tools, preset_external)[source]
-

Bases: object

-

Preset QUBIC.

-

Instance to initialize the Components Map-Making. It defines QUBIC variables and methods.

-
-
Parameters:
-
    -
  • preset_tools (object) – Class containing tools and simulation parameters.

  • -
  • preset_external (object)

  • -
-
-
-
-
-dict
-

Dictionary defining QUBIC caracteristics.

-
-
Type:
-

dict

-
-
-
- -
-
-joint_in
-

Class defining the QUBIC intrument to build the intial TOD.

-
-
Type:
-

object

-
-
-
- -
-
-joint_out
-

Class defining the QUBIC intrument to reconstruct the sky map.

-
-
Type:
-

object

-
-
-
- -

Methods

- - - - - - - - - -

get_components_fgb(key)

Components FGbuster

get_dict()

QUBIC dictionary.

-
-
-get_components_fgb(key)[source]
-

Components FGbuster

-

Method to build a dictionary containing all the wanted components to generate sky maps. -Based on FGBuster.

-
-
Returns:
-

dict_comps – Dictionary containing the component instances.

-
-
Return type:
-

dict

-
-
-
- -
-
-get_dict()[source]
-

QUBIC dictionary.

-

Method to modify the qubic dictionary.

-
-
Parameters:
-

key (str, optional) – Can be “in” or “out”. -It is used to build respectively the instances to generate the TODs or to reconstruct the sky maps, -by default “in”.

-
-
Returns:
-

dict_qubic – Modified QUBIC dictionary.

-
-
Return type:
-

dict

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/CMM.preset.preset_sky.html b/docs/_build/html/CMM.preset.preset_sky.html deleted file mode 100644 index fb19b32..0000000 --- a/docs/_build/html/CMM.preset.preset_sky.html +++ /dev/null @@ -1,268 +0,0 @@ - - - - - - - CMM.preset.preset_sky module — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

CMM.preset.preset_sky module

-
-
-class CMM.preset.preset_sky.PresetSky(preset_tools, preset_qubic)[source]
-

Bases: object

-

Preset Sky.

-

Instance to initialize the Components Map-Making. It defines the observed sky variables and methods.

-
-
Parameters:
-
    -
  • preset_tools (object) – Class containing tools and simulation parameters.

  • -
  • preset_qubic (object) – Class containing qubic operator and variables and methods.

  • -
-
-
-
-
-center
-

Defines the center of the QUBIC observation patch in (RA, DEC).

-
-
Type:
-

tuple

-
-
-
- -
-
-coverage
-

Defines the coverage of the QUBIC scanning strategy.

-
-
Type:
-

array_like

-
-
-
- -
-
-max_coverage
-

Defines the maximum of the coverage.

-
-
Type:
-

float

-
-
-
- -
-
-seenpix_qubic
-

Boolean array defining the pixels seen by QUBIC instrument.

-
-
Type:
-

array_like

-
-
-
- -
-
-seenpix
-

Boolean array defining the pixel with coverage > at a threshold chosen in params.yml.

-
-
Type:
-

array_like

-
-
-
- -
-
-namaster
-

NaMaster class instance.

-
-
Type:
-

object

-
-
-
- -
-
-ell
-

Multipole array, defining through NaMaster.

-
-
Type:
-

array_like

-
-
-
- -
-
-cl2dl
-

Array containing conversion factor to compute \(D_{\ell}\) from \(C_{\ell}\).

-
-
Type:
-

array_like

-
-
-
- -

Methods

- - - - - - - - - -

get_coverage()

Coverage.

get_spectra_namaster_informations()

NaMaster.

-
-
-get_coverage()[source]
-

Coverage.

-

Calculate the coverage mask for the QUBIC patch, according with the number of beta that you want to reconstruct.

-

This function computes the angular distance between a center point and all -pixels on a sphere, sorts these distances, and creates a mask that marks -the closest pixels as covered.

-
-
Returns:
-

mask – A mask array where covered pixels are marked with 1 and uncovered pixels are marked with 0.

-
-
Return type:
-

array_like

-
-
-
- -
-
-get_spectra_namaster_informations()[source]
-

NaMaster.

-

Initializes the Namaster object and computes the ell and cl2dl arrays.

-

This method sets up the Namaster object using parameters from the preset_tools -and computes the ell array and cl2dl conversion factor for power spectrum analysis.

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/CMM.preset.preset_tools.html b/docs/_build/html/CMM.preset.preset_tools.html deleted file mode 100644 index be4fd17..0000000 --- a/docs/_build/html/CMM.preset.preset_tools.html +++ /dev/null @@ -1,196 +0,0 @@ - - - - - - - CMM.preset.preset_tools module — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

CMM.preset.preset_tools module

-
-
-class CMM.preset.preset_tools.PresetTools(comm)[source]
-

Bases: object

-

Preset Tools.

-

Instance to initialize the Components Map-Making. It contains tool functions used in all the different files and the simulation parameters.

-
-
Parameters:
-

comm (MPI communicator) – MPI common communicator define by MPI.COMM_WORLD.

-
-
-
-
-params
-

Dictionary containing all the simulations parameters.

-
-
Type:
-

dict

-
-
-
- -

Methods

- - - - - - - - - - - - -

check_for_errors()

Errors check.

create_folder_if_not_exists(folder_name)

Create folder.

display_simulation_configuration()

Display the simulation configuration details.

-
-
-check_for_errors()[source]
-

Errors check.

-

Checks for various parameter errors in the ‘params.yml’ file.

-
-
Raises:
-

TypeError – If any of the parameter checks fail.

-
-
-
- -
-
-create_folder_if_not_exists(folder_name)[source]
-

Create folder.

-

Creates a folder with the specified name if it does not already exist.

-
-
Parameters:
-

folder_name (str) – The name of the folder to create.

-
-
-
- -
-
-display_simulation_configuration()[source]
-

Display the simulation configuration details.

-

This method prints out the configuration settings for the simulation, including -details about the sky input and output, QUBIC instrument settings, and MPI tasks. -The configuration is only displayed if the rank of the process is 0.

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/FMM.html b/docs/_build/html/FMM.html deleted file mode 100644 index e13f5e9..0000000 --- a/docs/_build/html/FMM.html +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - FMM package — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- - -
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/FMM.main.html b/docs/_build/html/FMM.main.html deleted file mode 100644 index f76956f..0000000 --- a/docs/_build/html/FMM.main.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - FMM.main module — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

FMM.main module

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/FMM.pipeline.html b/docs/_build/html/FMM.pipeline.html deleted file mode 100644 index d1f44f9..0000000 --- a/docs/_build/html/FMM.pipeline.html +++ /dev/null @@ -1,392 +0,0 @@ - - - - - - - FMM.pipeline module — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

FMM.pipeline module

-
-
-class FMM.pipeline.PipelineEnd2End(comm)[source]
-

Bases: object

-

FMM Pipeline.

-

Wrapper for End-2-End pipeline. It added class one after the others by running method.run().

-

Methods

- - - - - - -

main

-
-
-main(specific_file=None)[source]
-
- -
- -
-
-class FMM.pipeline.PipelineFrequencyMapMaking(comm, file, params)[source]
-

Bases: object

-

Instance to reconstruct frequency maps using QUBIC abilities.

-
-
Parameters:
-
-
comm

MPI communicator

-
-
filestr

used to create the forlder for data saving

-
-
paramsdict

dictionary containing all the simulation parameters

-
-
-
-
-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

get_H()

Acquisition operator

get_averaged_nus()

Average frequency

get_components_fgb()

Components FGbuster

get_convolution()

QUBIC resolutions.

get_dict([key])

QUBIC dictionary.

get_input_map()

Input maps.

get_preconditioner()

PCG Preconditioner.

get_random_value()

Random value

get_sky_config()

Sky configuration.

get_tod([noise])

Simulated TOD.

pcg(d, x0, seenpix)

Preconditioned Conjugate Gradiant algorithm.

run()

Run the FMM Pipeline.

-
-
-get_H()[source]
-

Acquisition operator

-

Method to compute QUBIC acquisition operators.

-
- -
-
-get_averaged_nus()[source]
-

Average frequency

-

Method to average QUBIC frequencies according to the number of reconstructed frequency maps.

-
-
Returns:
-

nus_ave – array containing the averaged QUBIC frequencies.

-
-
Return type:
-

array_like

-
-
-
- -
-
-get_components_fgb()[source]
-

Components FGbuster

-

Method to build a dictionary containing all the wanted components to generate sky maps. -Based on FGBuster.

-
-
Returns:
-

dict_comps – Dictionary containing the component instances.

-
-
Return type:
-

dict

-
-
-
- -
-
-get_convolution()[source]
-

QUBIC resolutions.

-

Method to define expected QUBIC angular resolutions (radians) as function of frequencies.

-
-
Returns:
-

    -
  • fwhm_in (array_like) – Intrinsic resolutions, used to build the simulated TOD.

  • -
  • fwhm_out (array_like) – Output resolutions. If we don’t apply convolutions during reconstruction, array of zeros.

  • -
  • fwhm_rec (array_like) – Reconstructed resolutions. Egal the output resolutions if we apply convolutions during reconstructions, evaluate through analytic formula otherwise.

  • -
-

-
-
-
- -
-
-get_dict(key='in')[source]
-

QUBIC dictionary.

-

Method to modify the qubic dictionary.

-
-
Parameters:
-

key (str, optional) – Can be “in” or “out”. -It is used to build respectively the instances to generate the TODs or to reconstruct the sky maps, -by default “in”.

-
-
Returns:
-

dict_qubic – Modified QUBIC dictionary.

-
-
Return type:
-

dict

-
-
-
- -
-
-get_input_map()[source]
-

Input maps.

-

Function to get the input maps from PySM3.

-
-
Returns:
-

maps_in – Input maps \((N_{rec}, 12 \times N^{2}_{side}, N_{stk})\).

-
-
Return type:
-

array_like

-
-
-
- -
-
-get_preconditioner()[source]
-

PCG Preconditioner.

-

Computed using the formula: To be added.

-
-
Returns:
-

M – Preconditioner for PCG algorithm.

-
-
Return type:
-

DiagonalOperator

-
-
-
- -
-
-get_random_value()[source]
-

Random value

-

Method to build a random seed.

-
-
Returns:
-

seed – Random seed.

-
-
Return type:
-

int

-
-
-
- -
-
-get_sky_config()[source]
-

Sky configuration.

-

Method that read ‘params.yml’ file and create dictionary containing sky emission model.

-
-
Returns:
-

dict_sky – Sky config dictionary.

-
-
Return type:
-

dict

-
-
-

Notes

-

Note that the key denote the emission and the value denote the sky model using PySM convention. -For CMB, seed denote the realization.

-

Example

-

d = {‘cmb’:seed, ‘dust’:’d0’, ‘synchrotron’:’s0’}

-
- -
-
-get_tod(noise=False)[source]
-

Simulated TOD.

-

Method that compute observed TODs with \(\vec{TOD} = H \cdot \vec{s} + \vec{n}\), with H the QUBIC operator, \(\vec{s}\) the sky signal and \(\vec{n}\) the instrumental noise`.

-
-
Parameters:
-

noise (bool, optional) – True if you want to simulate noise in your data, False otherwise, by default False.

-
-
Returns:
-

TOD – Simulated TOD \((N_{rec}, 12 \times N^{2}_{side}, N_{stk})\).

-
-
Return type:
-

array_like

-
-
-
- -
-
-pcg(d, x0, seenpix)[source]
-

Preconditioned Conjugate Gradiant algorithm.

-

Solve the map-making equation iteratively : \((H^T . N^{-1} . H) . x = H^T . N^{-1} . d\).

-

The PCG used for the minimization is intrinsequely parallelized (e.g see PyOperators).

-
-
Parameters:
-
    -
  • d (array_like) – Array containing the TODs generated previously \((N_{rec}, 12 \times N^{2}_{side}, N_{stk})\).

  • -
  • x0 (array_like) – Starting point of the PCG algorithm \((N_{rec}, 12 \times N^{2}_{side}, N_{stk})\).

  • -
  • seenpix (array_like) – Boolean array to define the pixels seen by QUBIC \((N_{rec}, 12 \times N^{2}_{side}, N_{stk})\).

  • -
-
-
Returns:
-

solution – Reconstructed maps \((N_{rec}, 12 \times N^{2}_{side}, N_{stk})\).

-
-
Return type:
-

array_like

-
-
-
- -
-
-run()[source]
-

Run the FMM Pipeline.

-

Method to run the whole pipeline from TOD generation from sky reconstruction by reading params.yml file.

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/CMM/pipeline.html b/docs/_build/html/_modules/CMM/pipeline.html deleted file mode 100644 index 7d23e82..0000000 --- a/docs/_build/html/_modules/CMM/pipeline.html +++ /dev/null @@ -1,1497 +0,0 @@ - - - - - - CMM.pipeline — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for CMM.pipeline

-### General packages
-import gc
-import os
-import sys
-import pickle
-from functools import partial
-
-import healpy as hp
-import numpy as np
-from pyoperators import MPI
-from pysimulators.interfaces.healpy import HealpixConvolutionGaussianOperator
-from scipy.optimize import fmin_l_bfgs_b, minimize
-
-import lib.Qmixing_matrix as mm
-### Local packages
-from lib.Qacquisition import *
-from lib.Qcg import pcg
-from lib.Qfoldertools import *
-from lib.Qmap_plotter import *
-# from simtools.mpi_tools import *
-from lib.Qnoise import *
-
-from .costfunc.chi2 import (Chi2Blind, Chi2DualBand, Chi2Parametric,
-                            Chi2Parametric_alt, Chi2UltraWideBand)
-# from simtools.analysis import *
-from .preset import *
-
-
-
-[docs] -class Pipeline: - """ - Instance to reconstruct component maps using QUBIC abilities. - - Parameters - ---------- - comm : MPI communicator - MPI common communicator define by MPI.COMM_WORLD. - seed : int - Seed for random CMB realization. - seed_noise : int, optional - Seed for random noise realization, by default None. - - """ - - def __init__(self, comm, seed, seed_noise=None): - """ - Initialize Pipeline instance. - - """ - - ### Creating noise seed - if seed_noise == -1: - if comm.Get_rank() == 0: - seed_noise = np.random.randint(100000000) - else: - seed_noise = None - seed_noise = comm.bcast(seed_noise, root=0) - - ### Initialization - self.preset = PresetInitialisation(comm, seed, seed_noise).initialize() - self.plots = PlotsCMM(self.preset, dogif=True) - if ( - self.preset.comp.params_foregrounds["Dust"]["type"] == "blind" - or self.preset.comp.params_foregrounds["Synchrotron"]["type"] == "blind" - ): - self.chi2 = Chi2Blind(self.preset) - else: - pass - - self.fsub = int( - self.preset.qubic.joint_out.qubic.nsub - / self.preset.comp.params_foregrounds["bin_mixing_matrix"] - ) - - ### Create variables for stopping condition - self._rms_noise_qubic_patch_per_ite = np.empty( - ( - self.preset.tools.params["PCG"]["ites_to_converge"], - len(self.preset.comp.components_name_out), - ) - ) - self._rms_noise_qubic_patch_per_ite[:] = np.nan - -
-[docs] - def fisher(self, ell, Nl): - """Fisher Method. - - Fisher to compute an estimation of sigma(r) for a given noise power spectrum. - - Parameters - ---------- - ell : array_like - Array containing the multipole values. - Nl : array_like - Array containing the noise power spectrum values. - - Returns - ------- - sigma: float - Estimated value of sigma(r). - - """ - - Dl = np.interp( - ell, np.arange(1, 4001, 1), self.preset.comp.give_cl_cmb(r=1, Alens=0)[2] - ) - sigma = np.sum( - (ell + 0.5) - * self.preset.sky.namaster.fsky - * self.preset.tools.params["SPECTRUM"]["dl"] - * (Dl / (Nl)) ** 2 - ) - - return sigma ** (-1 / 2)
- - -
-[docs] - def fisher_compute_sigma_r(self): - """Fisher estimation. - - Computes and prints the value of sigma(r) using the Fisher matrix. - - """ - - # Apply Gaussian beam convolution - C = HealpixConvolutionGaussianOperator( - fwhm=self.preset.acquisition.fwhm_reconstructed - ) - map_to_namaster = C( - self.preset.comp.components_iter[0] - self.preset.comp.components_out[0] - ) - - # Set unobserved pixels to zero - map_to_namaster[~self.preset.sky.seenpix, :] = 0 - - # Compute power spectra using NaMaster - leff, cls, _ = self.preset.sky.namaster.get_spectra( - map_to_namaster.T, - beam_correction=np.rad2deg(self.preset.acquisition.fwhm_reconstructed), - pixwin_correction=False, - verbose=False, - ) - - # Compute BB power spectrum and convert to delta ell - dl_BB = cls[:, 2] / self.preset.sky.cl2dl - - # Compute sigma(r) using Fisher matrix - sigma_r = self.fisher(leff, dl_BB) - - # Print the value of sigma(r) - self.preset.tools._print_message(f"sigma(r) = {sigma_r:.6f}")
- - -
-[docs] - def call_pcg(self, max_iterations, seenpix): - """Precontioned Conjugate Gradiant algorithm. - - Method to call the PCG from PyOperators package. - - Parameters - ---------- - max_iterations : int - Maximum number of iterations for the PCG algorithm. - seenpix : array_like - Boolean array that define the pixels observed by QUBIC. - - """ - - if self._steps == 0: - self.plots._display_allcomponents(seenpix, ki=-1) - - ### Initialize PCG starting point - initial_maps = self.preset.comp.components_iter[:, seenpix, :].copy() - - ### Update the precondtionner M - self.preset.acquisition.M = self.preset.acquisition._get_preconditioner( - A_qubic=self.preset.acquisition.Amm_iter[ - : self.preset.qubic.params_qubic["nsub_out"] - ], - A_ext=self.preset.mixingmatrix.Amm_in[ - self.preset.qubic.params_qubic["nsub_out"] : - ], - precond=self.preset.qubic.params_qubic["preconditionner"], - ) - - ### Run PCG - if self._steps == 0: - num_iter = self.preset.tools.params["PCG"]["n_init_iter_pcg"] - maxiter = self.preset.tools.params["PCG"]["n_init_iter_pcg"] - else: - num_iter = self.preset.tools.params["PCG"]["n_iter_pcg"] - maxiter = max_iterations - - if self.preset.tools.params["PCG"]["do_gif"]: - gif_folder = f"src/CMM/jobs/{self.preset.job_id}/iter/" - else: - gif_folder = None - - ### PCG - result = pcg( - A=self.preset.A, - b=self.preset.b, - comm=self.preset.comm, - x0=initial_maps, - M=self.preset.acquisition.M, - tol=self.preset.tools.params["PCG"]["tol_pcg"], - disp=True, - maxiter=maxiter, - gif_folder=gif_folder, - job_id=self.preset.job_id, - seenpix=seenpix, - seenpix_plot=seenpix, - center=self.preset.sky.center, - reso=self.preset.tools.params["PCG"]["reso_plot"], - fwhm_plot=self.preset.tools.params["PCG"]["fwhm_plot"], - input=self.preset.comp.components_out, - iter_init=self._steps * num_iter, - )["x"]["x"] - - ### Update components - self.preset.comp.components_iter[:, seenpix, :] = result.copy() - - ### Plot if asked - if self.preset.tools.rank == 0: - if self.preset.tools.params["PCG"]["do_gif"]: - do_gif( - f"src/CMM/jobs/{self.preset.job_id}/iter/", - "iter_", - output="animation.gif", - ) - self.plots.display_maps(seenpix, ki=self._steps) - self.plots._display_allcomponents( - seenpix, - ki=self._steps, - gif=self.preset.tools.params["PCG"]["do_gif"], - reso=self.preset.tools.params["PCG"]["reso_plot"], - ) - # self.plots._display_allresiduals(self.preset.comp.components_iter[:, self.preset.sky.seenpix, :], self.preset.sky.seenpix, ki=self._steps) - self.plots.plot_rms_iteration( - self.preset.acquisition.rms_plot, ki=self._steps - )
- - -
-[docs] - def update_components(self, seenpix): - r""" - Method that solves the map-making equation :math:`(H^T . N^{-1} . H) . x = H^T . N^{-1} . d`, using OpenMP / MPI solver. - - This method updates the components of the map by solving the map-making equation using an OpenMP / MPI solver. - The equation is of the form :math:`(H^T . N^{-1} . H) . \vec{c} = H^T . N^{-1} . \vec{TOD}`, where H_i is the operator obtained from the preset, - U is a reshaped operator, and x_planck and xI are intermediate variables used in the calculations. - - - Parameters - ---------- - seenpix : array_like - Boolean array that define the pixels observed by QUBIC. - - """ - - H_i = self.preset.qubic.joint_out.get_operator( - A=self.preset.acquisition.Amm_iter, - gain=self.preset.gain.gain_iter, - fwhm=self.preset.acquisition.fwhm_mapmaking, - nu_co=self.preset.comp.nu_co, - ) - - U = ( - ReshapeOperator( - (len(self.preset.comp.components_name_out) * sum(seenpix) * 3), - (len(self.preset.comp.components_name_out), sum(seenpix), 3), - ) - * PackOperator( - np.broadcast_to( - seenpix[None, :, None], - (len(self.preset.comp.components_name_out), seenpix.size, 3), - ).copy() - ) - ).T - - ### Update components when pixels outside the patch are fixed (assumed to be 0) - self.preset.A = U.T * H_i.T * self.preset.acquisition.invN * H_i * U - - if self.preset.qubic.params_qubic["convolution_out"]: - x_planck = self.preset.comp.components_convolved_out * ( - 1 - seenpix[None, :, None] - ) - else: - x_planck = self.preset.comp.components_out * (1 - seenpix[None, :, None]) - self.preset.b = U.T( - H_i.T - * self.preset.acquisition.invN - * (self.preset.acquisition.TOD_obs - H_i(x_planck)) - ) - - # TO BE REMOVE - ### Update components when intensity maps are fixed - # elif self.preset.tools.params['PCG']['fixI']: - # mask = np.ones((len(self.preset.comp.components_name_out), 12*self.preset.sky.params_sky['nside']**2, 3)) - # mask[:, :, 0] = 0 - # P = ( - # ReshapeOperator(PackOperator(mask).shapeout, (len(self.preset.comp.components_name_out), 12*self.preset.sky.params_sky['nside']**2, 2)) * - # PackOperator(mask) - # ).T - - # xI = self.preset.comp.components_convolved_out * (1 - mask) - # self.preset.A = P.T * H_i.T * self.preset.acquisition.invN * H_i * P - # self.preset.b = P.T (H_i.T * self.preset.acquisition.invN * (self.preset.acquisition.TOD_obs - H_i(xI))) - - ### Update components - # else: - # self.preset.A = H_i.T * self.preset.acquisition.invN * H_i - # self.preset.b = H_i.T * self.preset.acquisition.invN * self.preset.acquisition.TOD_obs - - ### Run PCG - self.call_pcg(self.preset.tools.params["PCG"]["n_iter_pcg"], seenpix=seenpix)
- - -
-[docs] - def get_tod_comp(self): - """Component TOD. - - Method that produces Time-Ordered Data (TOD) using the component maps computed at the current iteration. - - This method initializes a zero-filled numpy array `tod_comp` with dimensions based on the number of components, - the number of sub-components (multiplied by 2), and the product of the number of detectors and samples. - It then iterates over each component and sub-component to compute the TOD by applying a convolution operator - (if specified) and a mapping operator to the component maps. - - Returns - ------- - tod_comp: array_like - A numpy array containing the computed TOD for each component and sub-component. - - """ - - tod_comp = np.zeros( - ( - len(self.preset.comp.components_name_out), - self.preset.qubic.joint_out.qubic.nsub, - self.preset.qubic.joint_out.qubic.ndets - * self.preset.qubic.joint_out.qubic.nsamples, - ) - ) - - for i in range(len(self.preset.comp.components_name_out)): - for j in range(self.preset.qubic.joint_out.qubic.nsub): - if self.preset.qubic.params_qubic["convolution_out"]: - C = HealpixConvolutionGaussianOperator( - fwhm=self.preset.acquisition.fwhm_mapmaking[j], - lmax=3 * self.preset.sky.params_sky["nside"], - ) - else: - C = HealpixConvolutionGaussianOperator( - fwhm=0, lmax=3 * self.preset.sky.params_sky["nside"] - ) - tod_comp[i, j] = self.preset.qubic.joint_out.qubic.H[j]( - C(self.preset.comp.components_iter[i]) - ).ravel() - - return tod_comp
- - -
-[docs] - def callback(self, x): - """Callback for scipy.minimize. - - Method to make callback function readable by `scipy.optimize.minimize`. - - This method is intended to be used as a callback function during the optimization - process. It is called by the optimizer at each iteration. - - The method performs the following actions: - 1. Synchronizes all processes using a barrier to ensure that all processes reach this point before proceeding. - 2. If the current process is the root process (rank 0), it performs the following: - a. Every 5 iterations (when `self.nfev` is a multiple of 5), it prints the current iteration number and the parameter values rounded to 5 decimal places. - 3. Increments the iteration counter `self.nfev` by 1. - - Parameters - ---------- - x : array_like - The current parameter values at the current iteration of the optimization. - - """ - - self.preset.tools.comm.Barrier() - if self.preset.tools.rank == 0: - if (self.nfev % 1) == 0: - print( - f"Iter = {self.nfev:4d} x = {[np.round(x[i], 5) for i in range(len(x))]} qubic log(L) = {np.log(np.round(self.chi2.Lqubic, 5))} planck log(L) = {np.log(np.round(self.chi2.Lplanck, 5))}" - ) - self.nfev += 1
- - -
-[docs] - def get_constrains(self): - """Constraints for scipy.minimize. - - Generate constraints readable by `scipy.optimize.minimize`. - - Returns - ------- - constraints: list - A list of constraint dictionaries for optimize.minimize. - - """ - - constraints = [] - n = (self.preset.comp.params_foregrounds["bin_mixing_matrix"] - 1) * ( - len(self.preset.comp.components_name_out) - 1 - ) - - ### Dust only : constraint ==> SED is increasing - if ( - self.preset.comp.params_foregrounds["Dust"]["Dust_out"] - and not self.preset.comp.params_foregrounds["Synchrotron"]["Synchrotron_out"] - ): - for i in range(n): - constraints.append( - {"type": "ineq", "fun": lambda x, i=i: x[i + 1] - x[i]} - ) - - ### Synchrotron only : constraint ==> SED is decreasing - elif ( - not self.preset.comp.params_foregrounds["Dust"]["Dust_out"] - and self.preset.comp.params_foregrounds["Synchrotron"]["Synchrotron_out"] - ): - for i in range(n): - constraints.append( - {"type": "ineq", "fun": lambda x, i=i: x[i] - x[i + 1]} - ) - - ### No component : constraint ==> None - elif ( - not self.preset.comp.params_foregrounds["Dust"]["Dust_out"] - and not self.preset.comp.params_foregrounds["Synchrotron"]["Synchrotron_out"] - ): - return None - - ### Dust & Synchrotron : constraint ==> SED is increasing for one component and decrasing for the other one - elif ( - self.preset.comp.params_foregrounds["Dust"]["Dust_out"] - and self.preset.comp.params_foregrounds["Synchrotron"]["Synchrotron_out"] - ): - for i in range(n): - # Dust - if i % 2 == 0: - constraints.append( - {"type": "ineq", "fun": lambda x, i=i: x[i + 2] - x[i]} - ) - # Sync - else: - constraints.append( - {"type": "ineq", "fun": lambda x, i=i: x[i] - x[i + 2]} - ) - - return constraints
- - -
-[docs] - def get_tod_comp_superpixel(self, index): - if self.preset.tools.rank == 0: - print("Computing contribution of each super-pixel") - _index = np.zeros( - 12 * self.preset.comp.params_foregrounds["Dust"]["nside_beta_out"] ** 2 - ) - _index[index] = index.copy() - _index_nside = hp.ud_grade(_index, self.preset.qubic.joint_out.external.nside) - tod_comp = np.zeros( - ( - len(index), - self.preset.qubic.joint_out.qubic.nsub, - len(self.preset.comp.components_name_out), - self.preset.qubic.joint_out.qubic.ndets - * self.preset.qubic.joint_out.qubic.nsamples, - ) - ) - - maps_conv = self.preset.comp.components_iter.copy() - - for j in range(self.preset.qubic.params_qubic["nsub_out"]): - for icomp in range(len(self.preset.comp.components_name_out)): - if self.preset.qubic.params_qubic["convolution_out"]: - C = HealpixConvolutionGaussianOperator( - fwhm=self.preset.acquisition.fwhm_mapmaking[j], - lmax=3 * self.preset.sky.params_sky["nside"], - ) - else: - C = HealpixConvolutionGaussianOperator( - fwhm=0, lmax=3 * self.preset.sky.params_sky["nside"] - ) - maps_conv[icomp] = C(self.preset.comp.components_iter[icomp, :, :]).copy() - for ii, i in enumerate(index): - maps_conv_i = maps_conv.copy() - _i = _index_nside == i - for stk in range(3): - maps_conv_i[:, :, stk] *= _i - tod_comp[ii, j, icomp] = self.preset.qubic.joint_out.qubic.H[j]( - maps_conv_i[icomp] - ).ravel() - return tod_comp
- - -
-[docs] - def update_mixing_matrix(self, beta, previous_mixingmatrix, icomp): - """Update Mixing Matrix. - - Method to update the mixing matrix using the current fitted value of the beta parameter and the parametric model associated. - Only use when hybrid parametric-blind fit is selected ! - - Parameters - ---------- - beta : int - Spectral index. - previous_mixingmatrix : array_like - Mixing Matrix at the previous iteration :math:`(N_{sub} + N_{integr} . N_{Planck}, N_{comp})`. - icomp : int - Component index. - - Returns - ------- - updated_mixingmatrix: array_like - The updated Mixing Matrix. - - """ - - ### Build mixing matrix according to the choosen model and the beta parameter - mixingmatrix = mm.MixingMatrix(*self.preset.comp.components_out) - model_mixingmatrix = mixingmatrix.eval( - self.preset.qubic.joint_out.qubic.allnus, *beta - ) - - ### Update the mixing matrix according to the one computed using the beta parameter - updated_mixingmatrix = previous_mixingmatrix - for ii in range(self.preset.comp.params_foregrounds["bin_mixing_matrix"]): - updated_mixingmatrix[ii * self.fsub : (ii + 1) * self.fsub, icomp] = ( - model_mixingmatrix[ii * self.fsub : (ii + 1) * self.fsub, icomp] - ) - - return updated_mixingmatrix
- - -
-[docs] - def update_spectral_index(self): - """Update spectral index. - - Method that perform step 3) of the pipeline for 2 possible designs : Two Bands and Ultra Wide Band - - """ - method_0 = self.preset.comp.params_foregrounds[ - self.preset.comp.components_name_out[1] - ]["type"] - if len(self.preset.comp.components_name_out) > 1: - cpt = 2 - while cpt < len(self.preset.comp.components_name_out): - if ( - self.preset.comp.components_name_out[cpt] != "CO" - and self.preset.comp.params_foregrounds[ - self.preset.comp.components_name_out[cpt] - ]["type"] - != method_0 - ): - method = "parametric_blind" - cpt += 1 - try: - method == "parametric_blind" - except: - method = method_0 - - tod_comp = self.get_tod_comp() - self.nfev = 0 - self.preset.mixingmatrix._index_seenpix_beta = 0 - - if method == "parametric": - if self.preset.comp.params_foregrounds["Dust"]["nside_beta_out"] == 0: - - previous_beta = self.preset.acquisition.beta_iter.copy() - - if self.preset.qubic.params_qubic["instrument"] == "DB": - self.chi2 = Chi2DualBand(self.preset, tod_comp, parametric=True) - elif self.preset.qubic.params_qubic["instrument"] == "UWB": - self.chi2 = Chi2UltraWideBand( - self.preset, tod_comp, parametric=True - ) - - self.preset.acquisition.beta_iter = minimize( - self.chi2, - x0=self.preset.acquisition.beta_iter, - method="BFGS", - callback=self.callback, - tol=1e-10, - ).x - - self.preset.acquisition.Amm_iter = self.chi2._get_mixingmatrix( - nus=self.preset.qubic.joint_out.allnus, - x=self.preset.acquisition.beta_iter, - ) - # print(Ai.shape, Ai) - # for inu in range(self.preset.qubic.joint_out.qubic.nsub): - # for icomp in range(1, len(self.preset.comp.components_name_out)): - # self.preset.acquisition.Amm_iter[inu, icomp] = Ai[inu, icomp] - - del tod_comp - gc.collect() - - if self.preset.tools.rank == 0: - - print(f"Iteration k : {previous_beta}") - print( - f"Iteration k + 1 : {self.preset.acquisition.beta_iter.copy()}" - ) - print( - f"Truth : {self.preset.mixingmatrix.beta_in.copy()}" - ) - print( - f"Residuals : {self.preset.mixingmatrix.beta_in - self.preset.acquisition.beta_iter}" - ) - - # if len(self.preset.comp.components_name_out) > 2: - # self.plots.plot_beta_iteration(self.preset.acquisition.allbeta[:, 0], truth=self.preset.mixingmatrix.beta_in[0], ki=self._steps) - # else: - # self.plots.plot_beta_iteration(self.preset.acquisition.allbeta, truth=self.preset.mixingmatrix.beta_in, ki=self._steps) - - self.preset.tools.comm.Barrier() - - self.preset.acquisition.allbeta = np.concatenate( - ( - self.preset.acquisition.allbeta, - np.array([self.preset.acquisition.beta_iter]), - ), - axis=0, - ) - - else: - - index_num = hp.ud_grade( - self.preset.sky.seenpix_qubic, - self.preset.comp.params_foregrounds["Dust"]["nside_beta_out"], - ) # - self.preset.mixingmatrix._index_seenpix_beta = np.where( - index_num == True - )[0] - - ### Simulated TOD for each components, nsub, npix with shape (npix, nsub, ncomp, nsnd) - tod_comp = self.get_tod_comp_superpixel( - self.preset.mixingmatrix._index_seenpix_beta - ) - - ### Store fixed beta (those denoted with hp.UNSEEN are variable) - beta_fixed = self.preset.acquisition.beta_iter.copy() - beta_fixed[:, self.preset.mixingmatrix._index_seenpix_beta] = hp.UNSEEN - chi2 = Chi2DualBand( - self.preset, tod_comp, parametric=True, full_beta_map=beta_fixed - ) - # chi2 = Chi2Parametric(self.preset, tod_comp, self.preset.acquisition.beta_iter, seenpix_wrap=None) - - previous_beta = self.preset.acquisition.beta_iter[ - :, self.preset.mixingmatrix._index_seenpix_beta - ].copy() - self.nfev = 0 - - beta_i = fmin_l_bfgs_b( - chi2, - x0=previous_beta, - callback=self.callback, - approx_grad=True, - epsilon=1e-6, - maxls=20, - maxiter=20, - )[0] - - self.preset.acquisition.beta_iter[chi2.seenpix_beta] = beta_i - - del tod_comp - gc.collect() - - self.preset.acquisition.allbeta = np.concatenate( - ( - self.preset.acquisition.allbeta, - np.array([self.preset.acquisition.beta_iter]), - ), - axis=0, - ) - - if self.preset.tools.rank == 0: - - print(f"Iteration k : {previous_beta}") - print( - f"Iteration k + 1 : {self.preset.acquisition.beta_iter[:, self.preset.mixingmatrix._index_seenpix_beta].copy()}" - ) - print( - f"Truth : {self.preset.mixingmatrix.beta_in[:, self.preset.mixingmatrix._index_seenpix_beta].copy()}" - ) - print( - f"Residuals : {self.preset.mixingmatrix.beta_in[:, self.preset.mixingmatrix._index_seenpix_beta] - self.preset.acquisition.beta_iter[:, self.preset.mixingmatrix._index_seenpix_beta]}" - ) - self.plots.plot_beta_iteration( - self.preset.acquisition.allbeta[ - :, :, self.preset.mixingmatrix._index_seenpix_beta - ], - truth=self.preset.mixingmatrix.beta_in[ - :, self.preset.mixingmatrix._index_seenpix_beta - ], - ki=self._steps, - ) - elif method == "blind": - previous_step = self.preset.acquisition.Amm_iter[ - : self.preset.qubic.joint_out.qubic.nsub, 1: - ].copy() - if self._steps == 0: - self.allAmm_iter = np.array([self.preset.acquisition.Amm_iter]) - - if self.preset.comp.params_foregrounds["blind_method"] == "minimize": - - if self.preset.qubic.params_qubic["instrument"] == "DB": - self.chi2 = Chi2DualBand(self.preset, tod_comp, parametric=False) - elif self.preset.qubic.params_qubic["instrument"] == "UWB": - self.chi2 = Chi2UltraWideBand( - self.preset, tod_comp, parametric=False - ) - - x0 = [] - bnds = [] - for inu in range( - self.preset.comp.params_foregrounds["bin_mixing_matrix"] - ): - for icomp in range(1, len(self.preset.comp.components_name_out)): - x0 += [ - np.mean( - self.preset.acquisition.Amm_iter[ - inu * self.fsub : (inu + 1) * self.fsub, icomp - ] - ) - ] - bnds += [(0, None)] - - Ai = minimize( - self.chi2, - x0=x0, - # bounds=bnds, - method="BFGS", - # constraints=self.get_constrains(), - callback=self.callback, - tol=1e-10, - ).x - Ai = self.chi2._fill_A( - Ai - ) # Ai.reshape((self.preset.qubic.joint_out.qubic.nsub, len(self.preset.comp.components_name_out)-1)) - - for inu in range(self.preset.qubic.joint_out.qubic.nsub): - for icomp in range(1, len(self.preset.comp.components_name_out)): - self.preset.acquisition.Amm_iter[inu, icomp] = Ai[inu, icomp] - - """ - ### Function to minimize - fun = partial(self.chi2._qu, tod_comp=tod_comp) - - ### Starting point - x0 = [] - bnds = [] - for ii in range(self.preset.comp.params_foregrounds['bin_mixing_matrix']): - for i in range(1, len(self.preset.comp.components_name_out)): - x0 += [np.mean(self.preset.acquisition.Amm_iter[ii*self.fsub:(ii+1)*self.fsub, i])] - bnds += [(0, None)] - if self._steps == 0: - x0 = np.array(x0) * 1 + 0 - ### Constraints on frequency evolution - constraints = self.get_constrains() - - Ai = minimize(fun, x0=x0, - #constraints=constraints, - callback=self.callback, - bounds=bnds, - method='L-BFGS-B', - tol=1e-10).x - - k=0 - for ii in range(self.preset.comp.params_foregrounds['bin_mixing_matrix']): - for i in range(1, len(self.preset.comp.components_name_out)): - self.preset.acquisition.Amm_iter[ii*self.fsub:(ii+1)*self.fsub, i] = Ai[k] - k+=1 - """ - elif self.preset.comp.params_foregrounds["blind_method"] == "PCG": - tod_comp_binned = np.zeros( - ( - tod_comp.shape[0], - self.preset.comp.params_foregrounds["bin_mixing_matrix"], - tod_comp.shape[-1], - ) - ) - for k in range(len(self.preset.comp.components_name_out)): - for i in range( - self.preset.comp.params_foregrounds["bin_mixing_matrix"] - ): - tod_comp_binned[k, i] = np.sum( - tod_comp[k, i * self.fsub : (i + 1) * self.fsub], axis=0 - ) - - tod_cmb150 = self.preset.tools.comm.allreduce( - np.sum(tod_comp[0, : int(tod_comp.shape[1] / 2)], axis=0), - op=MPI.SUM, - ) - tod_cmb220 = self.preset.tools.comm.allreduce( - np.sum( - tod_comp[ - 0, int(tod_comp.shape[1] / 2) : int(tod_comp.shape[1]) - ], - axis=0, - ), - op=MPI.SUM, - ) - - tod_in_150 = self.preset.tools.comm.allreduce( - self.preset.TOD_Q[: int(self.preset.TOD_Q.shape[0] / 2)], op=MPI.SUM - ) - tod_in_220 = self.preset.tools.comm.allreduce( - self.preset.TOD_Q[ - int(self.preset.TOD_Q.shape[0] / 2) : int( - self.preset.TOD_Q.shape[0] - ) - ], - op=MPI.SUM, - ) - - tod_without_cmb = np.r_[ - tod_in_150 - tod_cmb150, tod_in_220 - tod_cmb220 - ] - tod_without_cmb_reshaped = np.sum( - tod_without_cmb.reshape((2, int(self.preset.nsnd / 2))), axis=0 - ) - - dnu = self.preset.tools.comm.allreduce(tod_comp_binned[1:], op=MPI.SUM) - dnu = dnu.reshape((dnu.shape[0] * dnu.shape[1], dnu.shape[2])) - - A = dnu @ dnu.T - b = dnu @ tod_without_cmb_reshaped - - s = mypcg(A, b, disp=False, tol=1e-20, maxiter=10000)["x"] - - k = 0 - for i in range(1, len(self.preset.comp.components_name_out)): - for ii in range( - self.preset.comp.params_foregrounds["bin_mixing_matrix"] - ): - self.preset.acquisition.Amm_iter[ - ii * self.fsub : (ii + 1) * self.fsub, i - ] = s["x"][ - k - ] # Ai[k] - k += 1 - elif self.preset.comp.params_foregrounds["blind_method"] == "alternate": - for i in range(len(self.preset.comp.components_name_out)): - if self.preset.comp.components_name_out[i] != "CMB": - print("I am fitting ", self.preset.comp.components_name_out[i]) - fun = partial( - self.chi2._qu_alt, - tod_comp=tod_comp, - A=self.preset.acquisition.Amm_iter, - icomp=i, - ) - - ### Starting point - x0 = [] - bnds = [] - for ii in range( - self.preset.comp.params_foregrounds["bin_mixing_matrix"] - ): - x0 += [ - np.mean( - self.preset.acquisition.Amm_iter[ - ii * self.fsub : (ii + 1) * self.fsub, i - ] - ) - ] - bnds += [(0, None)] - if self._steps == 0: - x0 = np.array(x0) * 1 + 0 - - Ai = minimize( - fun, - x0=x0, - callback=self.callback, - bounds=bnds, - method="SLSQP", - tol=1e-10, - ).x - - for ii in range( - self.preset.comp.params_foregrounds["bin_mixing_matrix"] - ): - self.preset.acquisition.Amm_iter[ - ii * self.fsub : (ii + 1) * self.fsub, i - ] = Ai[ii] - else: - raise TypeError( - f"{self.preset.comp.params_foregrounds['blind_method']} is not yet implemented.." - ) - - self.allAmm_iter = np.concatenate( - (self.allAmm_iter, np.array([self.preset.acquisition.Amm_iter])), axis=0 - ) - - if self.preset.tools.rank == 0: - # print(f'Iteration k : {previous_step.ravel()}') - # print(f'Iteration k + 1 : {self.preset.acquisition.Amm_iter[:self.preset.qubic.joint_out.qubic.nsub, 1:].ravel()}') - # print(f'Truth : {self.preset.mixingmatrix.Amm_in[:self.preset.qubic.joint_out.qubic.nsub, 1:].ravel()}') - # print(f'Residuals : {self.preset.mixingmatrix.Amm_in[:self.preset.qubic.joint_out.qubic.nsub, 1:].ravel() - self.preset.acquisition.Amm_iter[:self.preset.qubic.joint_out.qubic.nsub, 1:].ravel()}') - self.plots.plot_sed( - self.preset.qubic.joint_in.qubic.allnus, - self.preset.mixingmatrix.Amm_in[ - : self.preset.qubic.joint_in.qubic.nsub, 1: - ], - self.preset.qubic.joint_out.qubic.allnus, - self.preset.acquisition.Amm_iter[ - : self.preset.qubic.joint_out.qubic.nsub, 1: - ], - ki=self._steps, - gif=self.preset.tools.params["PCG"]["do_gif"], - ) - - if self.preset.tools.params["PCG"]["do_gif"]: - do_gif( - f"CMM/jobs/{self.preset.job_id}/A_iter/", - "A_iter", - output="animation_A_iter.gif", - ) - # do_gif(f'jobs/{self.preset.job_id}/allcomps/', 'iter_', output='animation.gif') - del tod_comp - gc.collect() - elif method == "parametric_blind": - previous_step = self.preset.acquisition.Amm_iter[ - : self.preset.qubic.joint_out.qubic.nsub * 2, 1: - ].copy() - if self._steps == 0: - self.allAmm_iter = np.array([self.preset.acquisition.Amm_iter]) - for i in range(len(self.preset.comp.components_name_out)): - if self.preset.comp.components_name_out[i] != "CMB": - if ( - self.preset.comp.params_foregrounds[ - self.preset.comp.components_name_out[i] - ]["type"] - == "parametric" - ): - print("I am fitting ", self.preset.comp.components_name_out[i], i) - - # if self._steps==0: - # self.preset.acquisition.beta_iter = self.preset.acquisition.beta_iter - previous_beta = self.preset.acquisition.beta_iter.copy() - - chi2 = Chi2Parametric_alt( - self.preset, - tod_comp, - self.preset.acquisition.Amm_iter, - i, - seenpix_wrap=None, - ) - - self.preset.acquisition.beta_iter[i - 1] = np.array( - [ - fmin_l_bfgs_b( - chi2, - x0=self.preset.acquisition.beta_iter[i - 1], - callback=self.callback, - approx_grad=True, - epsilon=1e-6, - )[0] - ] - ) - - self.preset.acquisition.Amm_iter = self.update_mixing_matrix( - self.preset.acquisition.beta_iter, - self.preset.acquisition.Amm_iter, - i, - ) - - else: - print("I am fitting ", self.preset.comp.components_name_out[i], i) - - fun = partial( - self.chi2._qu_alt, - tod_comp=tod_comp, - A=self.preset.acquisition.Amm_iter, - icomp=i, - ) - - ### Starting point - x0 = [] - bnds = [] - for ii in range( - self.preset.comp.params_foregrounds["bin_mixing_matrix"] - ): - for j in range(1, len(self.preset.comp.components_name_out)): - x0 += [ - np.mean( - self.preset.acquisition.Amm_iter[ - ii * self.fsub : (ii + 1) * self.fsub, j - ] - ) - ] - bnds += [(0, None)] - - Ai = minimize( - fun, - x0=x0, - callback=self.callback, - bounds=bnds, - method="SLSQP", - tol=1e-10, - ).x - - for ii in range( - self.preset.comp.params_foregrounds["bin_mixing_matrix"] - ): - self.preset.acquisition.Amm_iter[ - ii * self.fsub : (ii + 1) * self.fsub, i - ] = Ai[ii] - - self.allAmm_iter = np.concatenate( - (self.allAmm_iter, np.array([self.preset.acquisition.Amm_iter])), axis=0 - ) - - if self.preset.tools.rank == 0: - print(f"Iteration k : {previous_step.ravel()}") - print( - f"Iteration k + 1 : {self.preset.acquisition.Amm_iter[:self.preset.qubic.joint_out.qubic.nsub*2, 1:].ravel()}" - ) - print( - f"Truth : {self.preset.mixingmatrix.Amm_in[:self.preset.qubic.joint_out.qubic.nsub*2, 1:].ravel()}" - ) - print( - f"Residuals : {self.preset.mixingmatrix.Amm_in[:self.preset.qubic.joint_out.qubic.nsub*2, 1:].ravel() - self.preset.acquisition.Amm_iter[:self.preset.qubic.joint_out.qubic.nsub*2, 1:].ravel()}" - ) - self.plots.plot_sed( - self.preset.qubic.joint_out.qubic.allnus, - self.allAmm_iter[ - :, : self.preset.qubic.joint_out.qubic.nsub * 2, 1: - ], - ki=self._steps, - truth=self.preset.mixingmatrix.Amm_in[ - : self.preset.qubic.joint_out.qubic.nsub * 2, 1: - ], - gif=self.preset.tools.params["PCG"]["do_gif"], - ) - - del tod_comp - gc.collect()
- - -
-[docs] - def give_intercal(self, D, d, _invn): - r"""Detectors intercalibration. - - Semi-analytical method for gains estimation. (cf CMM paper) - - Parameters - ---------- - D : array_like - Simlulated data, given by the formula : :math:`\vec{D} = H.A.\vec{c}`, - where H is the pointing matrix, A the mixing matrix and c the component vector. - - d : array_like - Observed data, given by the formula : :math:`\vec{d} = G.\vec{D} + \vec{n}`, - where G is the detectors' intercalibration matrix and n the noise vector. - _invn : Diagonal Operator - Inverse noise covariance matrix. - - Returns - ------- - g: array_like - Intercalibration vector. - - """ - - _r = ReshapeOperator( - self.preset.qubic.joint_out.qubic.ndets - * self.preset.qubic.joint_out.qubic.nsamples, - ( - self.preset.qubic.joint_out.qubic.ndets, - self.preset.qubic.joint_out.qubic.nsamples, - ), - ) - - return (1 / np.sum(_r(D) * _invn(_r(D)), axis=1)) * np.sum( - _r(D) * _invn(_r(d)), axis=1 - )
- - -
-[docs] - def update_gain(self): - r"""Update detectors gain. - - Method that compute and print gains of each detectors using semi-analytical method decribed in "give_intercal" function, - using the formula : :math:`g^i = \frac{TOD_{obs}^i}{TOD_{sim}^i}`. - - """ - - self.H_i = self.preset.qubic.joint_out.get_operator( - self.preset.acquisition.beta_iter, - Amm=self.preset.acquisition.Amm_iter, - gain=np.ones(self.preset.gain.gain_iter.shape), - fwhm=self.preset.acquisition.fwhm_mapmaking, - nu_co=self.preset.comp.nu_co, - ) - self.nsampling = self.preset.qubic.joint_out.qubic.nsamples - self.ndets = self.preset.qubic.joint_out.qubic.ndets - - if self.preset.qubic.params_qubic["instrument"] == "UWB": - _r = ReshapeOperator( - self.preset.qubic.joint_out.qubic.ndets - * self.preset.joint.qubic.nsamples, - (self.preset.joint.qubic.ndets, self.preset.joint.qubic.nsamples), - ) - - TODi_Q = self.preset.acquisition.invN.operands[0]( - self.H_i.operands[0](self.preset.comp.components_iter)[ - : self.ndets * self.nsampling - ] - ) - self.preset.gain.gain_iter = self.give_intercal( - TODi_Q, _r(self.preset.TOD_Q) - ) - self.preset.gain.gain_iter /= self.preset.gain.gain_iter[0] - self.preset.allg = np.concatenate( - (self.preset.allg, np.array([self.preset.gain.gain_iter])), axis=0 - ) - - elif self.preset.qubic.params_qubic["instrument"] == "DB": - - TODi_Q_150 = self.H_i.operands[0](self.preset.comp.components_iter)[ - : self.ndets * self.nsampling - ] - TODi_Q_220 = self.H_i.operands[0](self.preset.comp.components_iter)[ - self.ndets * self.nsampling : 2 * self.ndets * self.nsampling - ] - - g150 = self.give_intercal( - TODi_Q_150, - self.preset.TOD_Q[: self.ndets * self.nsampling], - self.preset.acquisition.invN.operands[0].operands[1].operands[0], - ) - g220 = self.give_intercal( - TODi_Q_220, - self.preset.TOD_Q[ - self.ndets * self.nsampling : 2 * self.ndets * self.nsampling - ], - self.preset.acquisition.invN.operands[0].operands[1].operands[1], - ) - - self.preset.gain.gain_iter = np.array([g150, g220]).T - self.preset.Gi = join_data( - self.preset.tools.comm, self.preset.gain.gain_iter - ) - self.preset.allg = np.concatenate( - (self.preset.allg, np.array([self.preset.gain.gain_iter])), axis=0 - ) - - if self.preset.tools.rank == 0: - print(np.mean(self.preset.gain.gain_iter - self.preset.g, axis=0)) - print(np.std(self.preset.gain.gain_iter - self.preset.g, axis=0)) - - self.plots.plot_gain_iteration( - self.preset.allg - self.preset.g, alpha=0.03, ki=self._steps - )
- - -
-[docs] - def save_data(self, step): - f"""Save data. - - Method that save data for each iterations. - It saves components, gains, spectral index, coverage, seen pixels. - - Parameters - ---------- - step : int - Step number. - - """ - - if self.preset.tools.rank == 0: - if self.preset.tools.params["save_iter"] != 0: - if (step + 1) % self.preset.tools.params["save_iter"] == 0: - - if self.preset.tools.params["lastite"]: - - if step != 0: - os.remove( - "src/CMM/" - + self.preset.tools.params["foldername"] - + "/maps/" - + self.preset.tools.params["filename"] - + f"_seed{str(self.preset.tools.params['CMB']['seed'])}_{str(self.preset.job_id)}_k{step-1}.pkl" - ) - - with open( - "src/CMM/" - + self.preset.tools.params["foldername"] - + "/maps/" - + self.preset.tools.params["filename"] - + f"_seed{str(self.preset.tools.params['CMB']['seed'])}_{str(self.preset.job_id)}_k{step}.pkl", - "wb", - ) as handle: - pickle.dump( - { - "components": self.preset.comp.components_in, - "components_i": self.preset.comp.components_iter, - "beta": self.preset.acquisition.allbeta, - "beta_true": self.preset.mixingmatrix.beta_in, - "index_beta": self.preset.mixingmatrix._index_seenpix_beta, - "g": self.preset.gain.all_gain_in, - "gi": self.preset.gain.all_gain, - "allg": self.preset.gain.all_gain_iter, - "A": self.preset.acquisition.Amm_iter, - "Atrue": self.preset.mixingmatrix.Amm_in, - "G": self.preset.gain.all_gain_in, - "nus_in": self.preset.mixingmatrix.nus_eff_in, - "nus_out": self.preset.mixingmatrix.nus_eff_out, - "center": self.preset.sky.center, - "coverage": self.preset.sky.coverage, - "seenpix": self.preset.sky.seenpix, - "fwhm_in": self.preset.acquisition.fwhm_tod, - "fwhm_out": self.preset.acquisition.fwhm_mapmaking, - "fwhm_rec": self.preset.acquisition.fwhm_reconstructed, - #'fwhm':self.preset.acquisition.fwhm_tod, - #'acquisition.fwhm_reconstructed':self.preset.acquisition.fwhm_mapmaking - }, - handle, - protocol=pickle.HIGHEST_PROTOCOL, - )
- - - def _compute_map_noise_qubic_patch(self): - """ - - Compute the rms of the noise within the qubic patch. - - """ - nbins = 1 # average over the entire qubic patch - - # if self.preset.comp.params_foregrounds['Dust']['nside_beta_out'] == 0: - if self.preset.qubic.params_qubic["convolution_out"]: - residual = ( - self.preset.comp.components_iter - self.preset.comp.components_convolved_out - ) - else: - residual = self.preset.comp.components_iter - self.preset.comp.components_out - # else: - # if self.preset.qubic.params_qubic['convolution_out']: - # residual = self.preset.comp.components_iter.T - self.preset.comp.components_convolved_out - # else: - # residual = self.preset.comp.components_iter.T - self.preset.comp.components_out.T - rms_maxpercomp = np.zeros(len(self.preset.comp.components_name_out)) - - for i in range(len(self.preset.comp.components_name_out)): - angs, I, Q, U, dI, dQ, dU = get_angular_profile( - residual[i], - thmax=self.preset.angmax, - nbins=nbins, - doplot=False, - allstokes=True, - separate=True, - integrated=True, - center=self.preset.sky.center, - ) - - ### Set dI to 0 to only keep polarization fluctuations - dI = 0 - rms_maxpercomp[i] = np.max([dI, dQ, dU]) - return rms_maxpercomp - - def _compute_maxrms_array(self): - - if self._steps <= self.preset.tools.params["PCG"]["ites_to_converge"] - 1: - self._rms_noise_qubic_patch_per_ite[self._steps, :] = ( - self._compute_map_noise_qubic_patch() - ) - elif self._steps > self.preset.tools.params["PCG"]["ites_to_converge"] - 1: - self._rms_noise_qubic_patch_per_ite[:-1, :] = ( - self._rms_noise_qubic_patch_per_ite[1:, :] - ) - self._rms_noise_qubic_patch_per_ite[-1, :] = ( - self._compute_map_noise_qubic_patch() - ) - - def _stop_condition(self): - """ - Method that stop the convergence if there are more than k steps. - - """ - - if self._steps >= self.preset.tools.params["PCG"]["ites_to_converge"] - 1: - - deltarms_max_percomp = np.zeros(len(self.preset.comp.components_name_out)) - - for i in range(len(self.preset.comp.components_name_out)): - deltarms_max_percomp[i] = np.max( - np.abs( - ( - self._rms_noise_qubic_patch_per_ite[:, i] - - self._rms_noise_qubic_patch_per_ite[-1, i] - ) - / self._rms_noise_qubic_patch_per_ite[-1, i] - ) - ) - - deltarms_max = np.max(deltarms_max_percomp) - # if self.preset.tools.rank == 0: - # print(f'Maximum RMS variation for the last {self.preset.acquisition.ites_rms_tolerance} iterations: {deltarms_max}') - - if deltarms_max < self.preset.tools.params["PCG"]["tol_rms"]: - print( - f"RMS variations lower than {self.preset.acquisition.rms_tolerance} for the last {self.preset.acquisition.ites_rms_tolerance} iterations." - ) - - ### Update components last time with converged parameters - # self.update_components(maxiter=100) - self._info = False - - if self._steps >= self.preset.tools.params["PCG"]["n_iter_loop"] - 1: - - ### Update components last time with converged parameters - # self.update_components(maxiter=100) - - ### Wait for all processes and save data inside pickle file - # self.preset.tools.comm.Barrier() - # self.save_data() - - self._info = False - - self._steps += 1 - -
-[docs] - def main(self): - """Pipeline. - - Method to run the pipeline by following : - - 1) Initialize simulation using `PresetSims` instance reading `params.yml`. - - 2) Solve map-making equation knowing spectral index and gains. - - 3) Fit spectral index knowing components and gains. - - 4) Fit gains knowing components and sepctral index. - - 5) Repeat 2), 3) and 4) until convergence. - - """ - - self._info = True - self._steps = 0 - # print(self.preset.acquisition.beta_iter) - while self._info: - ### Display iteration - self.preset.tools._display_iter(self._steps) - - ### Update self.fg.components_iter^{k} -> self.fg.components_iter^{k+1} - self.update_components(seenpix=self.preset.sky.seenpix) - - ### Update self.preset.acquisition.beta_iter^{k} -> self.preset.acquisition.beta_iter^{k+1} - if self.preset.comp.params_foregrounds["fit_spectral_index"]: - self.update_spectral_index() - - ### Update self.gain.gain_iter^{k} -> self.gain.gain_iter^{k+1} - if self.preset.qubic.params_qubic["GAIN"]["fit_gain"]: - self.update_gain() - - ### Wait for all processes and save data inside pickle file - self.preset.tools.comm.Barrier() - self.save_data(self._steps) - - ### Compute the rms of the noise per iteration to later analyze its convergence in _stop_condition - # self._compute_maxrms_array() - - ### Stop the loop when self._steps > k - self._stop_condition()
-
- -
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/CMM/preset.html b/docs/_build/html/_modules/CMM/preset.html deleted file mode 100644 index 51cc9aa..0000000 --- a/docs/_build/html/_modules/CMM/preset.html +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - CMM.preset — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for CMM.preset

-from .preset_acquisition import *
-from .preset_external_data import *
-from .preset_components import *
-from .preset_gain import *
-from .preset_mixingmatrix import *
-from .preset_qubic import *
-from .preset_sky import *
-from .preset_tools import *
-
-
-
-[docs] -class PresetInitialisation: - """Preset initialization. - - Instance to initialize the Components Map-Making reading all the preset files. - - Arguments - --------- - comm: MPI communicator - MPI common communicator (define by MPI.COMM_WORLD). - seed: int - Seed for random CMB realization. - seed_noise: int - Seed for random noise realization. - - """ - - def __init__(self, comm, seed, seed_noise): - """ - Initialize the class with MPI communication. - - """ - - ### MPI common arguments - self.comm = comm - self.seed = seed - self.seed_noise = seed_noise - - self.tools = None - self.qubic = None - self.fg = None - self.gain = None - self.acquisition = None - self.external = None - self.sky = None - self.mixingmatrix = None - -
-[docs] - def initialize(self): - """Initialization. - - Method that initialize and return all the preset instances that will be used in Component Map-Making Pipeline. - - """ - self.tools = PresetTools(self.comm) - self.tools._print_message("========= Initialization =========") - self.tools._print_message(" => Checking simulation parameters") - self.tools.check_for_errors() - self.tools._print_message(" => No error detected !") - self.tools._print_message(" => Getting job ID") - self.job_id = os.environ.get("SLURM_JOB_ID") - self.tools._print_message(" => Creating folders") - if self.tools.rank == 0: - if self.tools.params["save_iter"] != 0: - self.tools.params["foldername"] = ( - f"{self.tools.params['Foregrounds']['Dust']['type']}_{self.tools.params['Foregrounds']['Dust']['model_d']}_{self.tools.params['QUBIC']['instrument']}_" - + self.tools.params["foldername"] - ) - self.tools.create_folder_if_not_exists( - "src/CMM/" + self.tools.params["foldername"] + "/maps/" - ) - if ( - self.tools.params["Plots"]["maps"] == True - or self.tools.params["Plots"]["conv_beta"] == True - ): - self.tools.create_folder_if_not_exists(f"src/CMM/jobs/{self.job_id}/I") - self.tools.create_folder_if_not_exists(f"src/CMM/jobs/{self.job_id}/Q") - self.tools.create_folder_if_not_exists(f"src/CMM/jobs/{self.job_id}/U") - self.tools.create_folder_if_not_exists( - f"src/CMM/jobs/{self.job_id}/allcomps" - ) - self.tools.create_folder_if_not_exists( - f"src/CMM/jobs/{self.job_id}/A_iter" - ) - - self.tools._print_message("========= External Data =========") - self.external = PresetExternal(self.tools) - - self.tools._print_message("========= QUBIC =========") - self.qubic = PresetQubic(self.tools, self.external) - - self.tools._print_message("========= Components =========") - self.comp = PresetComponents(self.tools, self.qubic, self.seed) - - self.tools._print_message("========= Sky =========") - self.sky = PresetSky(self.tools, self.qubic) - - self.tools._print_message("========= GAIN =========") - self.gain = PresetGain(self.tools, self.qubic) - - self.tools._print_message("========= Mixing Matrix =========") - self.mixingmatrix = PresetMixingMatrix(self.tools, self.qubic, self.fg) - - self.tools._print_message("========= Acquisition =========") - self.acquisition = PresetAcquisition( - self.seed_noise, - self.tools, - self.external, - self.qubic, - self.sky, - self.comp, - self.mixingmatrix, - self.gain, - ) - - self.tools.display_simulation_configuration() - - return self
-
- -
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/CMM/preset/preset_acquisition.html b/docs/_build/html/_modules/CMM/preset/preset_acquisition.html deleted file mode 100644 index a540de1..0000000 --- a/docs/_build/html/_modules/CMM/preset/preset_acquisition.html +++ /dev/null @@ -1,719 +0,0 @@ - - - - - - CMM.preset.preset_acquisition — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for CMM.preset.preset_acquisition

-import numpy as np
-from pyoperators import DiagonalOperator
-
-from lib.Qacquisition import *
-from lib.Qnoise import *
-
-
-
-[docs] -class PresetAcquisition: - r"""Preset Acquisition. - - Instance to initialize the Components Map-Making. It defines the data acquisition variables and methods. - - Parameters - ---------- - seed_noise : int - Seed for random noise generation. - preset_tools : object - Class containing tools and simulation parameters. - preset_external : object - Class containing external variables and methods. - preset_qubic : object - Class containing qubic operator and variables and methods. - preset_sky : object - Class containing sky varaibles and methods. - preset_comp : object - Class containing component variables and methods. - preset_mixing_matrix : object - Class containing mixing-matrix variables and methods. - preset_gain : object - Class containing detector gain variables and methods. - - Attributes - ---------- - seed_noise: int - Seed for random noise realization. - params_foregrounds: dict - Dictionary containing the paramters associated with foregrounds. - rms_tolerance: float - Tolerance for PCG algorithm. - ites_to_converge: int - Max iteration number for PCG algorithm. - invN: BlockDiagonalOperator - Inverse noise covariance matrix with input shape :math:`(N_{det}*N_{samples} + N_{pix}*N_{planck}*N_{stokes})` and output shape :math:`(N_{det}*N_{samples} + N_{pix}*N_{planck}*N_{stokes})`. - M: DiagonalOperator - Preconditioner for PCG algorithm. - fwhm_rec: array_like - Resolution of the reconstructed maps. - H: BlockColumnOperator - Pointing matrix. - TOD_qubic: array_like - QUBIC simulated TOD. - TOD_external: array_like - Planck simulated TOD. - TOD_obs: array_like - Simulated observed TOD. - beta_iter: array_like - Spectral indices, if d1 :math:`(12 \times Nside_{\beta}^2, N_{comp}-1)`, if not :math:`(N_{comp}-1)`. - allbeta: array_like - Spectral indeices, if d1 :math:`(iter, 12 \times Nside_{\beta}^2, N_{comp}-1)`, if not :math:`(iter, N_{comp}-1)`. - Amm_iter: array_like - Mixing matrix. - - """ - - # Notes - # ----- - # invN : - # .operands[0] = QUBIC, .operands[1] = Planck\ - # .operands[0].operands[0] = ReshapeOperator (Ndet, Nsamples) ---> (Ndet*Nsamples), .operands[0].operands[1] = ReshapeOperator (Ndet*Nsamples) ---> (Ndet, Nsamples)\ - # .operands[0].operands[0/1].operands[0] = 150 GHz focal plane , .operands[0].operands[0/1].operands[1] = 220 GHz focal plane\ - # H : - # .operands[0] = QUBIC / .operands[1] = Planck - - def __init__( - self, - seed_noise, - preset_tools, - preset_external, - preset_qubic, - preset_sky, - preset_comp, - preset_mixing_matrix, - preset_gain, - ): - """ - Initialization. - - """ - - ### Import preset Gain, Mixing Matrix, Foregrounds, Sky, QUBIC & tools - self.preset_tools = preset_tools - self.preset_external = preset_external - self.preset_qubic = preset_qubic - self.preset_sky = preset_sky - self.preset_comp = preset_comp - self.preset_mixingmatrix = preset_mixing_matrix - self.preset_gain = preset_gain - - ### Set noise seed - self.seed_noise = seed_noise - - ### Define tolerance of the rms variations - self.rms_tolerance = self.preset_tools.params["PCG"]["tol_rms"] - self.ites_to_converge = self.preset_tools.params["PCG"]["ites_to_converge"] - self.rms_plot = np.zeros((1, 2)) - - ### Inverse noise-covariance matrix - self.preset_tools._print_message( - " => Building inverse noise covariance matrix" - ) - self.invN = self.preset_qubic.joint_out.get_invntt_operator( - mask=self.preset_sky.mask - ) - - ### Preconditioner - self.preset_tools._print_message(" => Creating preconditioner") - self.M = self.get_preconditioner( - A_qubic=self.preset_mixingmatrix.Amm_in[ - : self.preset_qubic.params_qubic["nsub_out"] - ], - A_ext=self.preset_mixingmatrix.Amm_in[ - self.preset_qubic.params_qubic["nsub_out"] : - ], - precond=self.preset_qubic.params_qubic["preconditioner"], - thr=self.preset_tools.params["PLANCK"]["thr_planck"], - ) - - ### Get convolution - self.preset_tools._print_message(" => Getting convolution") - self.fwhm_tod, self.fwhm_mapmaking, self.fwhm_rec = self.get_convolution() - - ### Get observed data - self.preset_tools._print_message(" => Getting observational data") - self.get_tod() - - ### Compute initial guess for PCG - self.preset_tools._print_message(" => Initializing starting point") - self.get_x0() - -
-[docs] - def get_approx_hth(self): - r"""Approx HTH. - - Calculates the approximation of :math:`H^T.H`. - - Returns - ------- - approx_hth: array_like - The approximation of :math:`H^T.H` with shape :math:`(N_{sub}^{in}, N_{pixel}, 3)`. - approx_hth_ext: array_like - The approximation of :math:`H^T.H` for Planck. - - """ - - # Approximation of H.T H - approx_hth = np.empty( - (self.preset_qubic.params_qubic["nsub_out"],) - + self.preset_qubic.joint_out.qubic.H[0].shapein - ) - vector = np.ones(self.preset_qubic.joint_out.qubic.H[0].shapein) - for index in range(self.preset_qubic.params_qubic["nsub_out"]): - approx_hth[index] = ( - self.preset_qubic.joint_out.qubic.H[index].T - * self.preset_qubic.joint_out.qubic.invn150 - * self.preset_qubic.joint_out.qubic.H[index](vector) - ) - - invN_ext = self.preset_qubic.joint_out.external.get_invntt_operator( - mask=self.preset_sky.mask - ) - - _r = ReshapeOperator( - ( - len(self.preset_qubic.joint_out.external.nus), - approx_hth.shape[1], - approx_hth.shape[2], - ), - invN_ext.shapein, - ) - approx_hth_ext = invN_ext(np.ones(invN_ext.shapein)) - - return approx_hth, _r.T(approx_hth_ext)
- - -
-[docs] - def get_preconditioner(self, A_qubic, A_ext, precond=True, thr=0): - """Preconditioner for PCG algorithm. - - Calculates and returns the preconditioner matrix for the optimization process. - - Parameters - ---------- - A_qubic : array_like - QUBIC mixing matrix. - A_ext : array_like - Planck mixing matrix. - precond : bool, optional - Tells if you want a precontioner or not, by default True - thr : int, optional - Threshold to define the pixels seen by QUBIC, by default 0 - - Returns - ------- - M: DiagonalOperator - Preconditioner for PCG algorithm. - - """ - - if precond: - - seenpix_qubic_0_001 = ( - self.preset_sky.coverage / self.preset_sky.max_coverage > thr - ) - - # Calculate the approximate H^T * H matrix - approx_hth, approx_hth_ext = self.get_approx_hth() - - # Create a preconditioner matrix with dimensions (number of components, number of pixels, 3) - preconditioner = np.ones( - ( - len(self.preset_comp.components_model_out), - approx_hth.shape[1], - approx_hth.shape[2], - ) - ) - - for icomp in range(len(self.preset_comp.components_model_out)): - for istk in range(3): - precond_ext = 1 / ( - approx_hth_ext[:, :, 0].T @ A_ext[..., icomp] ** 2 - ) - precond_ext[precond_ext == np.inf] = 0 - preconditioner[icomp, :, istk] = precond_ext - preconditioner[ - icomp, seenpix_qubic_0_001, istk - ] *= self.preset_tools.params["PLANCK"]["weight_planck"] - - # We sum over the frequencies, take the inverse, and only keep the information on the patch. - for icomp in range(len(self.preset_comp.components_model_out)): - for istk in range(3): - precond_qubic = 1 / ( - approx_hth[:, :, 0].T @ A_qubic[..., icomp] ** 2 - ) - preconditioner[icomp, seenpix_qubic_0_001, istk] += precond_qubic[ - seenpix_qubic_0_001 - ] - - M = DiagonalOperator(preconditioner[:, self.preset_sky.seenpix, :]) - return M - else: - return None
- - -
-[docs] - def get_convolution(self): - """Convolutions. - - Method to define all angular resolutions of the instrument at each frequency. - - This method sets the Full Width at Half Maximum (FWHM) for Time-Ordered Data (TOD) and map-making processes. - `self.fwhm_tod` represents the real angular resolution, and `self.fwhm_mapmaking` represents the beams used for reconstruction. - - The method checks the `convolution_in` and `convolution_out` parameters to determine the appropriate FWHM values. - It also calculates the reconstructed FWHM based on these parameters. - - Returns - ------- - fwhm_tod: array_like - Resolutions to create input TOD. - fwhm_mapmaking: array_like - Resolutions for map-making. - fwhm_rec: array_like - Resolutions of reconstructed maps. - - """ - - # Initialize FWHM arrays to 0 - fwhm_tod = self.preset_qubic.joint_in.qubic.allfwhm * 0 - fwhm_mapmaking = self.preset_qubic.joint_in.qubic.allfwhm * 0 - - # Check if convolution_in is True - if self.preset_qubic.params_qubic["convolution_in"]: - fwhm_tod = self.preset_qubic.joint_in.qubic.allfwhm - - # Check if convolution_out is True - if self.preset_qubic.params_qubic["convolution_out"]: - swhm_mapmaking = np.sqrt( - self.preset_qubic.joint_in.qubic.allfwhm**2 - - np.min(self.preset_qubic.joint_in.qubic.allfwhm) ** 2 - ) - - # Calculate the reconstructed FWHM based on convolution parameters - if ( - self.preset_qubic.params_qubic["convolution_in"] - and self.preset_qubic.params_qubic["convolution_out"] - ): - fwhm_rec = np.min(self.preset_qubic.joint_in.qubic.allfwhm) - elif ( - self.preset_qubic.params_qubic["convolution_in"] - and not self.preset_qubic.params_qubic["convolution_out"] - ): - fwhm_rec = np.mean(self.preset_qubic.joint_in.qubic.allfwhm) - elif ( - not self.preset_qubic.params_qubic["convolution_in"] - and not self.preset_qubic.params_qubic["convolution_out"] - ): - fwhm_rec = 0 - - # Print the FWHM values - self.preset_tools._print_message(f"FWHM for TOD making : {fwhm_tod}") - self.preset_tools._print_message( - f"FWHM for reconstruction : {fwhm_mapmaking}" - ) - self.preset_tools._print_message( - f"Reconstructed FWHM : {fwhm_rec}" - ) - - return fwhm_tod, fwhm_mapmaking, fwhm_rec
- - - -
-[docs] - def get_noise(self): - """Noise. - - Method to define QUBIC noise, can generate Dual band or Wide Band noise by following: - - - Dual Band: n = [Ndet + Npho_150, Ndet + Npho_220] - - Wide Band: n = [Ndet + Npho_150 + Npho_220] - - Depending on the instrument type specified in the preset_qubic parameters, this method will - instantiate either QubicWideBandNoise or QubicDualBandNoise and return the total noise. - - Returns - ------- - noise: array_like - The total noise array, flattened. - - """ - - if self.preset_qubic.params_qubic["instrument"] == "UWB": - noise = QubicWideBandNoise( - self.preset_qubic.dict, - self.preset_qubic.params_qubic["npointings"], - detector_nep=self.preset_qubic.params_qubic["NOISE"]["detector_nep"], - duration=np.mean( - [ - self.preset_qubic.params_qubic["NOISE"]["duration_150"], - self.preset_qubic.params_qubic["NOISE"]["duration_220"], - ] - ), - ) - else: - noise = QubicDualBandNoise( - self.preset_qubic.dict, - self.preset_qubic.params_qubic["npointings"], - detector_nep=self.preset_qubic.params_qubic["NOISE"]["detector_nep"], - duration=[ - self.preset_qubic.params_qubic["NOISE"]["duration_150"], - self.preset_qubic.params_qubic["NOISE"]["duration_220"], - ], - ) - - return noise.total_noise( - self.preset_qubic.params_qubic["NOISE"]["ndet"], - self.preset_qubic.params_qubic["NOISE"]["npho150"], - self.preset_qubic.params_qubic["NOISE"]["npho220"], - seed_noise=self.seed_noise, - ).ravel()
- - -
-[docs] - def get_tod(self): - r"""TOD. - - Generate fake observational data from QUBIC and external experiments. - - This method simulates observational data, including astrophysical foregrounds contamination using `self.beta` and systematics using `self.g`. - The data generation follows the formula: :math:`\vec{d} = H.A.\vec{c} + \vec{n}`. - - Attributes - ---------- - H: Operator - Pointing matrix operator. - TOD_qubic: array_like - The simulated observational data for QUBIC. - TOD_external: array_like - The simulated observational data for external experiments. - TOD_obs: array_like - The combined observational data from QUBIC and external experiments. - nsampling_x_ndetectors: int - The number of samples in `self.TOD_qubic`. - - """ - - ### Build joint acquisition operator - self.H = self.preset_qubic.joint_in.get_operator( - A=self.preset_mixingmatrix.Amm_in, - gain=self.preset_gain.gain_in, - fwhm=self.fwhm_tod, - ) - - ### Create seed - if self.preset_tools.rank == 0: - np.random.seed(None) - seed_pl = np.random.randint(10000000) - else: - seed_pl = None - seed_pl = self.preset_tools.comm.bcast(seed_pl, root=0) - - ### Build noise variables - noise_external = ( - self.preset_qubic.joint_in.external.get_noise(seed=seed_pl) - * self.preset_tools.params["PLANCK"]["level_noise_planck"] - ) - noise_qubic = self.get_noise() - - ### Create QUBIC TOD - self.TOD_qubic = (self.H.operands[0])( - self.preset_comp.components_in - ) + noise_qubic - self.nsampling_x_ndetectors = self.TOD_qubic.shape[0] - - ### Create external TOD - self.TOD_external = (self.H.operands[1])( - self.preset_comp.components_in[:, :, :] - ) + noise_external - - _r = ReshapeOperator( - self.TOD_external.shape, - ( - len(self.preset_external.external_nus), - 12 * self.preset_sky.params_sky["nside"] ** 2, - 3, - ), - ) - maps_external = _r(self.TOD_external) - - ### Reconvolve Planck data toward QUBIC angular resolution - if ( - self.preset_qubic.params_qubic["convolution_in"] - or self.preset_qubic.params_qubic["convolution_out"] - ): - - C = HealpixConvolutionGaussianOperator( - fwhm=self.preset_qubic.joint_in.qubic.allfwhm[-1], - lmax=3 * self.preset_sky.params_sky["nside"], - ) - for i in range(maps_external.shape[0]): - maps_external[i] = C(maps_external[i]) - - # if self.preset_tools.params['PCG']['fix_pixels_outside_patch']: - # maps_external[:, ~self.preset_sky.seenpix_qubic, :] = 0 - self.TOD_external = _r.T(maps_external) - - # self.seenpix_external = np.tile(self.preset_sky.seenpix_qubic, (maps_external.shape[0], 3, 1)).reshape(maps_external.shape) - - ### Planck dataset with 0 outside QUBIC patch (Planck is assumed on the full sky) - maps_external[:, ~self.preset_sky.seenpix_qubic, :] = 0 - self.TOD_external_zero_outside_patch = _r.T(maps_external) - - ### Observed TOD (Planck is assumed on the full sky) - self.TOD_obs = np.r_[self.TOD_qubic, self.TOD_external] - self.TOD_obs_zero_outside = np.r_[ - self.TOD_qubic, self.TOD_external_zero_outside_patch - ]
- - -
-[docs] - def get_x0(self): - """PCG starting point. - - Define starting point of the convergence. - - The argument 'set_comp_to_0' multiplies the pixel values by a given factor. You can decide - to convolve the map by a beam with an FWHM in radians. - - This method initializes the beta_iter and Amm_iter attributes based on the foreground model parameters. - It also applies convolution and noise to the components based on the preset parameters. - - Raises - ------ - TypeError - If an unrecognized component name is encountered. - - """ - - ### Create seed - if self.preset_tools.rank == 0: - seed = np.random.randint(100000000) - else: - seed = None - seed = self.preset_tools.comm.bcast(seed, root=0) - np.random.seed(seed) - - self.beta_iter, self.Amm_iter = self.preset_mixingmatrix._get_beta_iter() - - # Build beta map for spatially varying spectral index - self.allbeta = np.array([self.beta_iter]) - C1 = HealpixConvolutionGaussianOperator( - fwhm=self.fwhm_rec, - lmax=3 * self.preset_tools.params["SKY"]["nside"], - ) - C2 = HealpixConvolutionGaussianOperator( - fwhm=self.preset_tools.params["INITIAL"]["fwhm0"], - lmax=3 * self.preset_tools.params["SKY"]["nside"], - ) - # Constant spectral index -> maps have shape (Ncomp, Npix, Nstk) - istk = 0 - mypix = self.preset_sky.seenpix - for i in range(len(self.preset_comp.components_model_out)): - if self.preset_comp.components_name_out[i] == "CMB": - self.preset_comp.components_iter[i] = C2( - C1(self.preset_comp.components_iter[i]) - ) - for istk in range(3): - if istk == 0: - key = "I" - else: - key = "P" - self.preset_comp.components_iter[ - i, mypix, istk - ] *= self.preset_tools.params["INITIAL"][f"qubic_patch_{key}_cmb"] - self.preset_comp.components_iter[i, mypix, istk] += np.random.normal( - 0, - self.preset_tools.params["INITIAL"]["sig_map_noise"], - self.preset_comp.components_iter[i, mypix, istk].shape, - ) - elif self.preset_comp.components_name_out[i] == "Dust": - self.preset_comp.components_iter[i] = C2( - C1(self.preset_comp.components_iter[i]) - ) - for istk in range(3): - if istk == 0: - key = "I" - else: - key = "P" - self.preset_comp.components_iter[ - i, mypix, istk - ] *= self.preset_tools.params["INITIAL"][f"qubic_patch_{key}_dust"] - self.preset_comp.components_iter[i, mypix, istk] += np.random.normal( - 0, - self.preset_tools.params["INITIAL"]["sig_map_noise"], - self.preset_comp.components_iter[i, mypix, istk].shape, - ) - elif self.preset_comp.components_name_out[i] == "Synchrotron": - self.preset_comp.components_iter[i] = C2( - C1(self.preset_comp.components_iter[i]) - ) - for istk in range(3): - if istk == 0: - key = "I" - else: - key = "P" - - self.preset_comp.components_iter[ - i, mypix, istk - ] *= self.preset_tools.params["INITIAL"][f"qubic_patch_{key}_sync"] - self.preset_comp.components_iter[i, mypix, istk] += np.random.normal( - 0, - self.preset_tools.params["INITIAL"]["sig_map_noise"], - self.preset_comp.components_iter[i, mypix, istk].shape, - ) - elif self.preset_comp.components_name_out[i] == "CO": - self.preset_comp.components_iter[i] = C2( - C1(self.preset_comp.components_iter[i]) - ) - self.preset_comp.components_iter[i, mypix, :] *= self.preset_tools.params[ - "INITIAL" - ]["qubic_patch_co"] - self.preset_comp.components_iter[i, mypix, :] += np.random.normal( - 0, - self.preset_tools.params["INITIAL"]["sig_map_noise"], - self.preset_comp.components_iter[i, mypix, :].shape, - ) - else: - raise TypeError( - f"{self.preset_comp.components_name_out[i]} not recognized" - )
-
- - - # else: - # self.allbeta = np.array([self.beta_iter]) - # C1 = HealpixConvolutionGaussianOperator(fwhm=self.fwhm_rec, lmax=3*self.preset_tools.params['SKY']['nside']) - # C2 = HealpixConvolutionGaussianOperator(fwhm=self.preset_tools.params['INITIAL']['fwhm0'], lmax=3*self.preset_tools.params['SKY']['nside']) - # ### Varying spectral indices -> maps have shape (Nstk, Npix, Ncomp) - # for i in range(len(self.preset_comp.components_model_out)): - # if self.preset_comp.components_name_out[i] == 'CMB': - # #print(self.preset_comp.components_iter.shape) - # self.preset_comp.components_iter[:, :, i] = C2(C1(self.preset_comp.components_iter[:, :, i].T)).T - # self.preset_comp.components_iter[1:, self.preset_sky.seenpix, i] *= self.preset_tools.params['INITIAL']['qubic_patch_cmb'] - - # elif self.preset_comp.components_name_out[i] == 'Dust': - # self.preset_comp.components_iter[:, :, i] = C2(C1(self.preset_comp.components_iter[:, :, i].T)).T + np.random.normal(0, self.preset_tools.params['INITIAL']['sig_map_noise'], self.preset_comp.components_iter[:, :, i].T.shape).T - # self.preset_comp.components_iter[1:, self.preset_sky.seenpix, i] *= self.preset_tools.params['INITIAL']['qubic_patch_dust'] - - # elif self.preset_comp.components_name_out[i] == 'Synchrotron': - # self.preset_comp.components_iter[:, :, i] = C2(C1(self.preset_comp.components_iter[:, :, i].T)).T + np.random.normal(0, self.preset_tools.params['INITIAL']['sig_map_noise'], self.preset_comp.components_iter[:, :, i].T.shape).T - # self.preset_comp.components_iter[1:, self.preset_sky.seenpix, i] *= self.preset_tools.params['INITIAL']['qubic_patch_sync'] - - # elif self.preset_comp.components_name_out[i] == 'CO': - # self.preset_comp.components_iter[:, :, i] = C2(C1(self.preset_comp.components_iter[:, :, i].T)).T + np.random.normal(0, self.preset_tools.params['INITIAL']['sig_map_noise'], self.preset_comp.components_iter[:, :, i].T.shape).T - # self.preset_comp.components_iter[1:, self.preset_sky.seenpix, i] *= self.preset_tools.params['INITIAL']['qubic_patch_co'] - # else: - # raise TypeError(f'{self.preset_comp.components_name_out[i]} not recognize') -
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/CMM/preset/preset_components.html b/docs/_build/html/_modules/CMM/preset/preset_components.html deleted file mode 100644 index b030711..0000000 --- a/docs/_build/html/_modules/CMM/preset/preset_components.html +++ /dev/null @@ -1,500 +0,0 @@ - - - - - - CMM.preset.preset_components — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for CMM.preset.preset_components

-import os
-
-import healpy as hp
-import numpy as np
-import pysm3
-import pysm3.units as u
-from pysimulators.interfaces.healpy import HealpixConvolutionGaussianOperator
-from pysm3 import utils
-
-PATH = os.getcwd() + "/src/data/"
-
-
-
-[docs] -class PresetComponents: - """Preset Components. - - Instance to initialize the Components Map-Making. It defines the Foregrounds variables and methods. - - Parameters - ---------- - seed_noise : int - Seed for random CMB noise generation. - preset_tools : object - Class containing tools and simulation parameters. - preset_qubic : object - Class containing qubic operator and variables and methods. - - Attributes - ---------- - params_cmb: dict - Dictionary containing the parameters associated with CMB. - params_foregrounds: dict - Dictionary containing the parameters associated with foregrounds. - seed: int - Seed for random CMB noise generation. - skyconfig: dict - Dictionary containing the wanted sky configuration for PySM. - components_model: list - List containing the FGBuster instance relative to the wanted components. - components_name: list - List containing the name of the components. - components: array_like - Components maps according to chosen model. - components_convolved: array_like - Convolved components maps. - components_iter: array_like - Initilize array on which we will iterate to reconstruct components maps. - nu_co: int - Frequency of the monochromatic emission, None if not chosen. - - """ - - def __init__(self, preset_tools, preset_qubic, seed): - """ - Initialize. - - """ - ### Import preset QUBIC & tools - self.preset_tools = preset_tools - self.preset_qubic = preset_qubic - - ### Define variable for Foregrounds parameters - self.params_cmb = self.preset_tools.params["CMB"] - self.params_foregrounds = self.preset_tools.params["Foregrounds"] - - ### Define seed for CMB generation and noise - self.seed = seed - - ### Skyconfig - self.preset_tools._print_message(" => Creating sky configuration") - self.skyconfig_in = self.get_sky_config(key="in") - self.skyconfig_out = self.get_sky_config(key="out") - - ### Define model for reconstruction - self.preset_tools._print_message(" => Creating model") - self.components_model_in, self.components_name_in = ( - self.preset_qubic.get_components_fgb(key="in") - ) - self.components_model_out, self.components_name_out = ( - self.preset_qubic.get_components_fgb(key="out") - ) - - ### Compute true components - self.preset_tools._print_message(" => Creating components") - self.components_in, self.components_convolved_in, _ = self.get_components( - self.skyconfig_in - ) - self.components_out, self.components_convolved_out, self.components_iter = ( - self.get_components(self.skyconfig_out) - ) - - ### Monochromatic emission - if self.preset_tools.params["Foregrounds"]["CO"]["CO_in"]: - self.nu_co = self.preset_tools.params["Foregrounds"]["CO"]["nu0_co"] - else: - self.nu_co = None - -
-[docs] - def get_sky_config(self, key): - """Sky configuration. - - Method to define the sky model used by PySM3 to generate a fake sky. - - Parameters - ---------- - key : str - The key to access the specific parameters in the prest configuration. - Can be either "in" or "out". - - Returns - ------- - skyconfig: dict - Dictionary containing the sky model configuration. - - Example - ------- - sky = {'cmb': 42, 'Dust': 'd0'} - - """ - - sky = {} - if self.params_cmb["cmb"]: - sky["CMB"] = self.seed - - if self.preset_tools.params["Foregrounds"]["Dust"][f"Dust_{key}"]: - sky["Dust"] = self.preset_tools.params["Foregrounds"]["Dust"]["model_d"] - - if self.preset_tools.params["Foregrounds"]["Synchrotron"][f"Synchrotron_{key}"]: - sky["Synchrotron"] = self.preset_tools.params["Foregrounds"]["Synchrotron"][ - "model_s" - ] - - if self.preset_tools.params["Foregrounds"]["CO"][f"CO_{key}"]: - sky["coline"] = "co2" - - return sky
- - -
-[docs] - def give_cl_cmb(self, r=0, Alens=1.0): - r""":math:`C_{\ell}^{BB}` CMB. - - Generates the CMB BB power spectrum with optional lensing and tensor contributions. - - Parameters - ---------- - r : int, optional - Tensor-to-scalar ratio, by default 0 - Alens : float, optional - Lensing amplitude, by default 1.0 - - Returns - ------- - power_spectrum: array_like - CMB power spectrum according to r and Alens. - - """ - - # Read the lensed scalar power spectrum from the FITS file - power_spectrum = hp.read_cl(PATH + "Cls_Planck2018_lensed_scalar.fits")[ - :, :4000 - ] - - # Adjust the lensing amplitude if Alens is not the default value - if Alens != 1.0: - power_spectrum[2] *= Alens - - # Add tensor contributions if r is not zero - if r: - power_spectrum += ( - r - * hp.read_cl( - PATH + "Cls_Planck2018_unlensed_scalar_and_tensor_r1.fits" - )[:, :4000] - ) - - return power_spectrum
- - -
-[docs] - def polarized_I(self, m, nside, polarization_fraction=0): - """Polarized intensity map. - - Calculates the polarized intensity map. - - Parameters - ---------- - m : array_like - Input map to be polarised - nside : int - Nside parameter of the HEALPix map. - polarization_fraction : float, optional - Fraction of polarization, by default 0 - - Returns - ------- - p_map: array_like - Array containing the polarized intensity map with cosine and sine components. - - """ - - # Read and downgrade the polarization angle map to the desired nside resolution - polangle = hp.ud_grade( - hp.read_map(os.getcwd() + "/src/data/" + "psimap_dust90_512.fits"), nside - ) - - # Read and downgrade the depolarization map to the desired nside resolution - depolmap = hp.ud_grade( - hp.read_map(os.getcwd() + "/src/data/" + "gmap_dust90_512.fits"), nside - ) - - # Calculate the cosine of twice the polarization angle - cospolangle = np.cos(2.0 * polangle) - - # Calculate the sine of twice the polarization angle - sinpolangle = np.sin(2.0 * polangle) - - # Calculate the polarized intensity map by scaling the input map with the depolarization map and polarization fraction - p_map = polarization_fraction * depolmap * hp.ud_grade(m, nside) - - # Return the polarized intensity map with cosine and sine components - return p_map * np.array([cospolangle, sinpolangle])
- - -
-[docs] - def get_components(self, skyconfig): - """Components maps. - - Read configuration dictionary which contains every compoenent and their associated model. - The CMB is randomly generated from a specific seed. - Astrophysical foregrounds come from PySM 3. - - Parameters - ---------- - skyconfig : dict - Dictionary containing the configuration for each component. - - Returns - ------- - components: array_like - Components maps according to chosen model. - components_convolved: array_like - Convolved components maps. - components_iter: array_like - Initilize array on which we will iterate to reconstruct components maps. - - Raises - ------ - TypeError - Raises if the chosen model does not exist. - - """ - - ### Initialization - components = np.zeros( - (len(skyconfig), 12 * self.preset_tools.params["SKY"]["nside"] ** 2, 3) - ) - components_convolved = np.zeros( - (len(skyconfig), 12 * self.preset_tools.params["SKY"]["nside"] ** 2, 3) - ) - - ### Compute convolution operator if needed - if ( - self.preset_qubic.params_qubic["convolution_in"] - or self.preset_qubic.params_qubic["convolution_out"] - ): - C = HealpixConvolutionGaussianOperator( - fwhm=self.preset_qubic.joint_in.qubic.allfwhm[-1], - lmax=3 * self.preset_tools.params["SKY"]["nside"], - ) - else: - C = HealpixConvolutionGaussianOperator(fwhm=0) - - ### Compute CMB power spectrum according Planck data - mycls = self.give_cl_cmb(r=self.params_cmb["r"], Alens=self.params_cmb["Alens"]) - - ### Build components list - for icomp, comp_name in enumerate(skyconfig.keys()): - # CMB case - if comp_name == "CMB": - np.random.seed(skyconfig[comp_name]) - cmb = hp.synfast( - mycls, - self.preset_tools.params["SKY"]["nside"], - verbose=False, - new=True, - ).T - components[icomp] = cmb.copy() - components_convolved[icomp] = C(cmb).copy() - - # Dust case - elif comp_name == "Dust": - sky_dust = pysm3.Sky( - nside=self.preset_tools.params["SKY"]["nside"], - preset_strings=[ - self.preset_tools.params["Foregrounds"]["Dust"]["model_d"] - ], - output_unit="uK_CMB", - ) - - sky_dust.components[0].mbb_temperature = ( - 20 * sky_dust.components[0].mbb_temperature.unit - ) - map_Dust = ( - np.array( - sky_dust.get_emission( - self.preset_tools.params["Foregrounds"]["Dust"]["nu0_d"] - * u.GHz, - None, - ).T - * utils.bandpass_unit_conversion( - self.preset_tools.params["Foregrounds"]["Dust"]["nu0_d"] - * u.GHz, - None, - u.uK_CMB, - ) - ) - * self.preset_tools.params["Foregrounds"]["Dust"]["amplification_d"] - ) - components[icomp] = map_Dust.copy() - components_convolved[icomp] = C(map_Dust).copy() - - # Synchrotron case - elif comp_name == "Synchrotron": - sky_sync = pysm3.Sky( - nside=self.preset_tools.params["SKY"]["nside"], - preset_strings=[ - self.preset_tools.params["Foregrounds"]["Synchrotron"][ - "model_s" - ] - ], - output_unit="uK_CMB", - ) - - map_sync = ( - np.array( - sky_sync.get_emission( - self.preset_tools.params["Foregrounds"]["Synchrotron"][ - "nu0_s" - ] - * u.GHz, - None, - ).T - * utils.bandpass_unit_conversion( - self.preset_tools.params["Foregrounds"]["Synchrotron"][ - "nu0_s" - ] - * u.GHz, - None, - u.uK_CMB, - ) - ) - * self.preset_tools.params["Foregrounds"]["Synchrotron"][ - "amplification_s" - ] - ) - components[icomp] = map_sync.copy() - components_convolved[icomp] = C(map_sync).copy() - - # CO emission case - elif comp_name == "coline": - map_co = hp.ud_grade( - hp.read_map("data/CO_line.fits") * 10, - self.preset_tools.params["SKY"]["nside"], - ) - map_co_polarised = self.polarized_I( - map_co, - self.preset_tools.params["SKY"]["nside"], - polarization_fraction=self.preset_tools.params["Foregrounds"]["CO"][ - "polarization_fraction" - ], - ) - sky_co = np.zeros( - (12 * self.preset_tools.params["SKY"]["nside"] ** 2, 3) - ) - sky_co[:, 0] = map_co.copy() - sky_co[:, 1:] = map_co_polarised.T.copy() - components[icomp] = sky_co.copy() - components_convolved[icomp] = C(sky_co).copy() - - else: - raise TypeError("Choose right foreground model (d0, s0, ...)") - - # if self.preset_tools.params['Foregrounds']['Dust']['nside_beta_out'] != 0: - # components = components.T.copy() - components_iter = components.copy() - - return components, components_convolved, components_iter
-
- -
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/CMM/preset/preset_external_data.html b/docs/_build/html/_modules/CMM/preset/preset_external_data.html deleted file mode 100644 index 2649cb1..0000000 --- a/docs/_build/html/_modules/CMM/preset/preset_external_data.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - CMM.preset.preset_external_data — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for CMM.preset.preset_external_data

-
-[docs] -class PresetExternal: - """Preset External Data. - - Instance to initialize the Components Map-Making. It defines the external data variables and methods. - - Parameters - ---------- - preset_tools: object - Class containing tools and simulation parameters. - - Attributes - ---------- - external_nus : list - List containing Planck maps frequency. - - """ - - def __init__(self, preset_tools): - """ - Initialization. - - """ - - ### Define Planck parameters variable - self.params_external = preset_tools.params["PLANCK"] - - ### External frequencies - preset_tools._print_message(" => Computing Planck frequency bands") - self.external_nus = self.get_external_nus() - -
-[docs] - def get_external_nus(self): - """External frequencies. - - Method to create a Python list of external frequencies by reading the `params.yml` file. - - This method reads the `params.yml` file and checks for the presence of specific frequency - values under the 'PLANCK' section. If a frequency is present, it is added to the external - frequencies list. - - Returns - ------- - external_nus : list - List containing Planck maps frequency. - - """ - - ### List of all Planck's frequency bands - allnus = [30, 44, 70, 100, 143, 217, 353] - - ### Build variable with selected frequency bands - external = [] - for nu in allnus: - if self.params_external[f"{nu:.0f}GHz"]: - external += [nu] - - return external
-
- -
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/CMM/preset/preset_gain.html b/docs/_build/html/_modules/CMM/preset/preset_gain.html deleted file mode 100644 index 67fe846..0000000 --- a/docs/_build/html/_modules/CMM/preset/preset_gain.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - CMM.preset.preset_gain — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for CMM.preset.preset_gain

-import numpy as np
-
-from lib.Qmpi_tools import join_data
-
-
-
-[docs] -class PresetGain: - """Preset Detectors Gain. - - Instance to initialize the Components Map-Making. It defines the input detectors gain variables and methodes. - - Parameters - ---------- - preset_tools : object - Class containing tools and simulation parameters. - preset_qubic : object - Class containing qubic operator and variables and methods. - - """ - - def __init__(self, preset_tools, preset_qubic): - """ - Initialize. - - """ - ### Import preset QUBIC & tools - self.preset_qubic = preset_qubic - self.preset_tools = preset_tools - - ### Get input detectors gain - self.preset_tools._print_message(" => Getting detectors gain") - self.get_input_gain() - -
-[docs] - def get_input_gain(self): - """Input gains. - - Generates and processes input gain values for the instrument based on preset parameters. - - This method sets the `gain_in`, `all_gain_in`, `gain_iter`, `all_gain`, and `all_gain_iter` - attributes of the instance. The gain values are generated using a normal distribution and may be - adjusted based on the instrument type and preset parameters. - - """ - - np.random.seed(None) - if self.preset_qubic.params_qubic["instrument"] == "UWB": - self.gain_in = np.random.normal( - 1, - self.preset_qubic.params_qubic["GAIN"]["sig_gain"], - self.preset_qubic.joint_in.qubic.ndets, - ) - else: - self.gain_in = np.random.normal( - 1, - self.preset_qubic.params_qubic["GAIN"]["sig_gain"], - (self.preset_qubic.joint_in.qubic.ndets, 2), - ) - - self.all_gain_in = join_data(self.preset_tools.comm, self.gain_in) - - if self.preset_qubic.params_qubic["GAIN"]["fit_gain"]: - gain_err = 0.2 - self.gain_iter = np.random.uniform( - self.gain_in - gain_err / 2, - self.gain_in + gain_err / 2, - self.gain_in.shape, - ) - else: - self.gain_iter = np.ones(self.gain_in.shape) - - self.all_gain = join_data(self.preset_tools.comm, self.gain_iter) - self.all_gain_iter = np.array([self.gain_iter])
-
- -
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/CMM/preset/preset_mixingmatrix.html b/docs/_build/html/_modules/CMM/preset/preset_mixingmatrix.html deleted file mode 100644 index 7ea3c0f..0000000 --- a/docs/_build/html/_modules/CMM/preset/preset_mixingmatrix.html +++ /dev/null @@ -1,599 +0,0 @@ - - - - - - CMM.preset.preset_mixingmatrix — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for CMM.preset.preset_mixingmatrix

-import numpy as np
-import pysm3
-import pysm3.units as u
-
-from lib.Qmixing_matrix import MixingMatrix
-
-
-
-[docs] -class PresetMixingMatrix: - """Preset Mixing Matrix. - - Instance to initialize the Components Map-Making. It defines Mixing Matrix variables and methodes. - - Parameters - ---------- - preset_tools : object - Class containing tools and simulation parameters. - preset_qubic : object - Class containing qubic operator and variables and methods. - preset_comp : object - Class containing component variables and methods. - - Attributes - ---------- - nus_eff_in: array_like - Input effective frequencies. - nus_eff_out: array_like - Output effective frequencies. - Amm_in: array_like - Input mixing matrix. - beta_in: array_like - Input spectral indices. - - """ - - def __init__(self, preset_tools, preset_qubic, preset_comp): - """ - Initialize. - - """ - ### Import preset Foregrounds, QUBIC & tools - self.preset_tools = preset_tools - self.preset_qubic = preset_qubic - self.preset_comp = preset_comp - - ### Store frequencies - self.nus_eff_in = np.array( - list(self.preset_qubic.joint_in.qubic.allnus) - + list(self.preset_qubic.joint_in.external.allnus) - ) - self.nus_eff_out = np.array( - list(self.preset_qubic.joint_out.qubic.allnus) - + list(self.preset_qubic.joint_out.external.allnus) - ) - - ### Get input spectral index - self.preset_tools._print_message(" => Building Mixing Matrix") - self.get_beta_input() - self.get_index_seenpix_beta() - -
-[docs] - def extra_sed(self, nus, correlation_length): - """Spectral Energy Distribution. - - Calculates the extra SED (Spectral Energy Distribution) based on the given parameters. - - Parameters - ---------- - nus : array_like - Array containing frequencies. - correlation_length : float - The correlation lenght. - - Returns - ------- - extra: array_like - Array containing the extra SED values. - - """ - - np.random.seed(1) - extra = np.ones(len(nus)) - - if self.preset_comp.params_foregrounds["Dust"]["model_d"] != "d6": - return np.ones(len(nus)) - - else: - for ii, i in enumerate(nus): - rho_covar, rho_mean = pysm3.models.dust.get_decorrelation_matrix( - 353 * u.GHz, - np.array([i]) * u.GHz, - correlation_length=correlation_length * u.dimensionless_unscaled, - ) - rho_covar, rho_mean = np.array(rho_covar), np.array(rho_mean) - - extra[ii] = rho_mean[:, 0] + rho_covar @ np.random.randn(1) - - return extra
- - - ''' - def _get_Amm(self, comps, comp_name, nus, beta_d=1.54, beta_s=-3, init=False): - """ - Compute the mixing matrix A for given components and frequencies. - - Parameters: - comps (list): List of component objects. - comp_name (list): List of component names corresponding to `comps`. - nus (list): List of frequency values. - beta_d (float, optional): Spectral index for Dust component. Defaults to 1.54. - beta_s (float, optional): Spectral index for Synchrotron component. Defaults to -3. - init (bool, optional): Flag to indicate if this is an initialization step. Defaults to False. - - Returns: - np.ndarray: The computed mixing matrix A of shape (len(nus), len(comps)). - """ - - # Set default spectral indices if not provided - if beta_d is None: - # beta_d = 1.54 - beta_d = np.random.normal( - self.preset_comp.params_foregrounds['Dust']['beta_d_init'][0], - self.preset_comp.params_foregrounds['Dust']['beta_d_init'][1], - 1 - ) - if beta_s is None: - # beta_s = -3 - beta_s = np.random.normal( - self.preset_comp.params_foregrounds['Synchrotron']['beta_s_init'][0], - self.preset_comp.params_foregrounds['Synchrotron']['beta_s_init'][1], - 1 - ) - - # Determine the number of components and frequencies - ncomp, nfreq = len(comps), len(nus) - # Initialize the mixing matrix with zeros - A = np.zeros((nfreq, ncomp)) - - # Check if the Dust model is 'd6' and not in initialization step - if self.preset_comp.params_foregrounds['Dust']['model_d'] == 'd6' and init == False: - # Compute extra scaling factor for Dust component - extra = self.extra_sed(nus, self.preset_comp.params_foregrounds['Dust']['l_corr']) - else: - # Default scaling factor is 1 for all frequencies - extra = np.ones(nfreq) - - for inu, nu in enumerate(nus): - for jcomp in range(ncomp): - # If the component is CMB, set the mixing matrix value to 1 - if comp_name[jcomp] == 'CMB': - A[inu, jcomp] = 1. - # If the component is Dust, evaluate the component and apply the extra scaling factor - elif comp_name[jcomp] == 'Dust': - A[inu, jcomp] = comps[jcomp].eval(nu, np.array([beta_d]))[0][0] * extra[inu] - # If the component is Synchrotron, evaluate the component - elif comp_name[jcomp] == 'Synchrotron': - A[inu, jcomp] = comps[jcomp].eval(nu, np.array([beta_s])) - return A - ''' - -
-[docs] - def spectral_index_modifiedblackbody(self, nside): - """ModifiedBlackBody spectral indices. - - Method to define input spectral indices if the d1 model is used for thermal Dust description. - - Parameters - ---------- - nside : int - Nside parameter for HEALPix map. - - Returns - ------- - mbb_index: array_like - Array containing the spectral indices for the thermal Dust model. - - """ - - sky = pysm3.Sky(nside=nside, preset_strings=["d1"]) - return np.array(sky.components[0].mbb_index)
- - -
-[docs] - def spectral_index_powerlaw(self, nside): - """PowerLaw spectral indices. - - Define input spectral indices if the s1 model is used for Synchrotron description. - - Parameters - ---------- - nside : int - Nside parameter for HEALPix map. - - Returns - ------- - pl_index: array_like - Array containing the spectral indices for the Synchrotron model. - - """ - - sky = pysm3.Sky(nside=nside, preset_strings=["s1"]) - return np.array(sky.components[0].pl_index)
- - -
-[docs] - def get_decorrelated_mixing_matrix(self, lcorr, seed, key="in"): - """Decorrelated mixing matrix. - - Parameters - ---------- - lcorr : float - Correlation lenght. - seed : int - Seed for random decorrealtion. - key : str, optional - The key to access the specific parameters in the prest configuration. - Can be either "in" or "out", by default "in" - - Returns - ------- - Adeco: array_like - Decorrelated mixing matrix. - - """ - - if key == "in": - nus_eff = self.nus_eff_in - comps = self.preset_comp.components_model_in - nus_qubic = self.preset_qubic.joint_in.qubic.allnus - elif key == "out": - nus_eff = self.nus_eff_out - comps = self.preset_comp.components_model_out - nus_qubic = self.preset_qubic.joint_out.qubic.allnus - - Adeco = np.ones((len(nus_eff), len(comps))) - - if self.preset_comp.params_foregrounds["Dust"]["Dust_out"]: - A = MixingMatrix(*comps) - idust = A.components.index("Dust") - for ii, i in enumerate(nus_qubic): - np.random.seed(seed + ii) - - rho_covar, rho_mean = pysm3.models.dust.get_decorrelation_matrix( - 353 * u.GHz, - np.array([i]) * u.GHz, - correlation_length=lcorr * u.dimensionless_unscaled, - ) - rho_covar, rho_mean = np.array(rho_covar), np.array(rho_mean) - Adeco[ii, idust] = rho_mean[:, 0] + rho_covar @ np.random.randn(1) - - return Adeco
- - -
-[docs] - def get_mixingmatrix(self, nus, beta, key="in"): - """Mixing Matrix. - - Method to get the mixing matrix from FGBuster according to compoenents model. - - Parameters - ---------- - nus : array_like - Array containing frequencies. - beta : float - Spectral index. - key : str, optional - The key to access the specific parameters in the prest configuration. - Can be either "in" or "out", by default "in" - - Returns - ------- - Amm: array_like - Mixing matrix. - - Raises - ------ - ValueError - Raises in case of incorrect key. - """ - - ### Compute mixing matrix - if key == "in": - mixingmatrix = MixingMatrix(*self.preset_comp.components_model_in) - elif key == "out": - mixingmatrix = MixingMatrix(*self.preset_comp.components_model_out) - else: - raise ValueError - return mixingmatrix.eval(nus, *beta)
- - - def _get_beta_iter(self): - - if self.preset_comp.params_foregrounds["Dust"]["model_d"] in ["d0", "d6"]: - - beta_iter = np.array([]) - if self.preset_comp.params_foregrounds["Dust"]["Dust_out"]: - beta_iter = np.append( - beta_iter, - np.random.normal( - self.preset_comp.params_foregrounds["Dust"]["beta_d_init"][0], - self.preset_comp.params_foregrounds["Dust"]["beta_d_init"][1], - 1, - ), - ) - if self.preset_comp.params_foregrounds["Synchrotron"]["Synchrotron_out"]: - beta_iter = np.append( - beta_iter, - np.random.normal( - self.preset_comp.params_foregrounds["Synchrotron"]["beta_s_init"][ - 0 - ], - self.preset_comp.params_foregrounds["Synchrotron"]["beta_s_init"][ - 1 - ], - 1, - ), - ) - - Adeco_iter = self.get_decorrelated_mixing_matrix( - self.preset_comp.params_foregrounds["Dust"]["beta_d_init"][2], - seed=42, - key="out", - ) - A_iter = ( - self.get_mixingmatrix(self.nus_eff_out, beta_iter, key="out") - * Adeco_iter - ) - - return beta_iter, A_iter - - elif self.preset_comp.params_foregrounds["Dust"]["model_d"] == "d1": - beta_iter = np.zeros( - ( - len(self.preset_comp.components_out) - 1, - 12 - * self.preset_comp.params_foregrounds["Dust"]["nside_beta_out"] ** 2, - ) - ) - for iname, name in enumerate(self.preset_comp.components_name_out): - if name == "CMB": - pass - elif name == "Dust": - beta_iter[iname - 1] = ( - self.spectral_index_modifiedblackbody( - self.preset_comp.params_foregrounds["Dust"]["nside_beta_out"] - ) - * 0 - + 1.54 - ) - elif name == "Synchrotron": - beta_iter[iname - 1] = ( - self.spectral_index_powerlaw( - self.preset_comp.params_foregrounds["Dust"]["nside_beta_out"] - ) - * 0 - - 3 - ) - - Amm_iter = self.get_mixingmatrix(self.nus_eff_out, beta_iter) - Amm_iter = np.transpose(Amm_iter, (1, 0, 2)) - return beta_iter, Amm_iter - else: - raise TypeError( - f"{self.preset_comp.params_foregrounds['Dust']['model_d']} is not yet implemented..." - ) - -
-[docs] - def get_beta_input(self): - """Spectral index. - - Define the input spectral indices based on the model type. - - If the model is 'd0' or 'd6', the input spectral index is fixed (1.54). - Otherwise, the model assumes varying spectral indices across the sky by calling the previous method. - In this case, the shape of beta is (Nbeta, Ncomp). - - Attributes - ---------- - nus_eff_in: array_like - Input effective frequencies. - nus_eff_out: array_like - Output effective frequencies. - Amm_in: array_like - Input mixing matrix. - beta_in: array_like - Input spectral indices. - - Raises - ------ - TypeError - Raises if the chosen model is not implemented. - - """ - - if self.preset_comp.params_foregrounds["Dust"]["model_d"] in ["d0", "d6"]: - - # self.Amm_in = self._get_Amm(self.preset_comp.components_model_in, self.preset_comp.components_name_in, self.nus_eff_in, init=False) - - # self.Amm_in[len(self.preset_qubic.joint_in.qubic.allnus):] = self._get_Amm(self.preset_comp.components_model_in, self.preset_comp.components_name_in, self.nus_eff_in, init=True)[len(self.preset_qubic.joint_in.qubic.allnus):] - if self.preset_comp.params_foregrounds["CO"]["CO_in"]: - self.beta_in = np.array( - [ - float(i._REF_BETA) - for i in self.preset_comp.components_model_in[1:-1] - ] - ) - else: - self.beta_in = np.array( - [float(i._REF_BETA) for i in self.preset_comp.components_model_in[1:]] - ) - - self.Amm_in = self.get_mixingmatrix( - self.nus_eff_in, self.beta_in, key="in" - ) - - if self.preset_comp.params_foregrounds["Dust"]["Dust_in"]: - if self.preset_comp.params_foregrounds["Dust"]["model_d"] in ["d0", "d6"]: - Adeco = self.get_decorrelated_mixing_matrix( - lcorr=self.preset_comp.params_foregrounds["Dust"]["l_corr"], - seed=1, - key="in", - ) - - ### Multiply the right element once even with multiple processors - if self.preset_tools.rank == 0: - # print(self.Amm_in) - # print(Adeco) - # stop - self.Amm_in *= Adeco - else: - self.Amm_in = None - self.Amm_in = self.preset_tools.comm.bcast(self.Amm_in, root=0) - - elif self.preset_comp.params_foregrounds["Dust"]["model_d"] == "d1": - # self.Amm_in = None - self.beta_in = np.zeros( - ( - len(self.preset_comp.components_in) - 1, - 12 - * self.preset_comp.params_foregrounds["Dust"]["nside_beta_in"] - ** 2, - ) - ) - for iname, name in enumerate(self.preset_comp.components_name_in): - if name == "CMB": - pass - elif name == "Dust": - self.beta_in[iname - 1] = ( - self.spectral_index_modifiedblackbody( - self.preset_comp.params_foregrounds["Dust"][ - "nside_beta_in" - ] - ) - ) - elif name == "Synchrotron": - self.beta_in[iname - 1] = self.spectral_index_powerlaw( - self.preset_comp.params_foregrounds["Dust"][ - "nside_beta_in" - ] - ) - - self.Amm_in = self.get_mixingmatrix(self.nus_eff_in, self.beta_in) - self.Amm_in = np.transpose(self.Amm_in, (1, 0, 2)) - # print(self.Amm_in.shape) - # stop - - else: - raise TypeError( - f"{self.preset_comp.params_foregrounds['Dust']['model_d']} is not yet implemented..." - )
- - -
-[docs] - def get_index_seenpix_beta(self): - """Spatially varying spectral index. - - Method to initialize index seenpix beta variable. - - """ - - if self.preset_comp.params_foregrounds["fit_spectral_index"]: - self._index_seenpix_beta = 0 - else: - self._index_seenpix_beta = None
-
- -
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/CMM/preset/preset_qubic.html b/docs/_build/html/_modules/CMM/preset/preset_qubic.html deleted file mode 100644 index fe31d74..0000000 --- a/docs/_build/html/_modules/CMM/preset/preset_qubic.html +++ /dev/null @@ -1,320 +0,0 @@ - - - - - - CMM.preset.preset_qubic — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for CMM.preset.preset_qubic

-import numpy as np
-import qubic
-
-import lib.Qcomponent_model as c
-from lib.Qacquisition import JointAcquisitionComponentsMapMaking
-
-
-
-[docs] -class PresetQubic: - """Preset QUBIC. - - Instance to initialize the Components Map-Making. It defines QUBIC variables and methods. - - Parameters - ---------- - preset_tools : object - Class containing tools and simulation parameters. - preset_external : object - - Attributes - ---------- - dict: dict - Dictionary defining QUBIC caracteristics. - joint_in: object - Class defining the QUBIC intrument to build the intial TOD. - joint_out: object - Class defining the QUBIC intrument to reconstruct the sky map. - - """ - - def __init__(self, preset_tools, preset_external): - """Initialize. - - """ - ### Import preset tools - self.preset_tools = preset_tools - - ### Define QUBIC parameters variable - self.params_qubic = self.preset_tools.params["QUBIC"] - - ### MPI common arguments - self.comm = self.preset_tools.comm - self.size = self.comm.Get_size() - # print(self.size) - # stop - - ### QUBIC dictionary - self.preset_tools._print_message(" => Reading QUBIC dictionary") - self.dict = self.get_dict() - - ### Define model for reconstruction - components_fgb_in, _ = self.get_components_fgb(key="in") - components_fgb_out, _ = self.get_components_fgb(key="out") - - if self.preset_tools.params["Foregrounds"]["CO"]["CO_in"]: - nu_co = self.preset_tools.params["Foregrounds"]["CO"]["nu0_co"] - else: - nu_co = None - - ### Joint acquisition for QUBIC operator - self.preset_tools._print_message(" => Building QUBIC operator") - self.joint_in = JointAcquisitionComponentsMapMaking( - self.dict, - self.params_qubic["instrument"], - components_fgb_in, - self.params_qubic["nsub_in"], - preset_external.external_nus, - preset_external.params_external["nintegr_planck"], - nu_co=nu_co, - ) - - if self.params_qubic["nsub_in"] == self.params_qubic["nsub_out"]: - self.joint_out = JointAcquisitionComponentsMapMaking( - self.dict, - self.params_qubic["instrument"], - components_fgb_out, - self.params_qubic["nsub_in"], - preset_external.external_nus, - preset_external.params_external["nintegr_planck"], - nu_co=nu_co, - H=self.joint_in.qubic.H, - ) - else: - self.joint_out = JointAcquisitionComponentsMapMaking( - self.dict, - self.params_qubic["instrument"], - components_fgb_out, - self.params_qubic["nsub_out"], - preset_external.external_nus, - preset_external.params_external["nintegr_planck"], - nu_co=nu_co, - H=None, - ) - -
-[docs] - def get_dict(self): - """QUBIC dictionary. - - Method to modify the qubic dictionary. - - Parameters - ---------- - key : str, optional - Can be "in" or "out". - It is used to build respectively the instances to generate the TODs or to reconstruct the sky maps, - by default "in". - - Returns - ------- - dict_qubic: dict - Modified QUBIC dictionary. - - """ - - ### Construct the arguments dictionary with required parameters - args = { - "npointings": self.params_qubic["npointings"], - "nf_recon": 1, - "nf_sub": self.params_qubic["nsub_in"], - "nside": self.preset_tools.params["SKY"]["nside"], - "MultiBand": True, - "period": 1, - "RA_center": self.preset_tools.params["SKY"]["RA_center"], - "DEC_center": self.preset_tools.params["SKY"]["DEC_center"], - "filter_nu": 150 * 1e9, - "noiseless": False, - "comm": self.comm, - "kind": "IQU", - "config": "FI", - "verbose": False, - "dtheta": self.params_qubic["dtheta"], - "nprocs_sampling": 1, - "nprocs_instrument": self.size, - "photon_noise": True, - "nhwp_angles": 3, - #'effective_duration': 3, - "effective_duration150": self.params_qubic["NOISE"]["duration_150"], - "effective_duration220": self.params_qubic["NOISE"]["duration_220"], - "filter_relative_bandwidth": 0.25, # difference_frequency_nu_over_nu, - #'type_instrument': 'wide', - "TemperatureAtmosphere150": None, - "TemperatureAtmosphere220": None, - "EmissivityAtmosphere150": None, - "EmissivityAtmosphere220": None, - "detector_nep": float(self.params_qubic["NOISE"]["detector_nep"]), - "synthbeam_kmax": self.params_qubic["SYNTHBEAM"]["synthbeam_kmax"], - "synthbeam_fraction": self.params_qubic["SYNTHBEAM"]["synthbeam_fraction"], - } - - ### Get the default dictionary - dictfilename = "dicts/pipeline_demo.dict" - d = qubic.qubicdict.qubicDict() - d.read_from_file(dictfilename) - - ### Update the default dictionary with the constructed parameters - for i in args.keys(): - d[str(i)] = args[i] - - return d
- - -
-[docs] - def get_components_fgb(self, key): - """Components FGbuster - - Method to build a dictionary containing all the wanted components to generate sky maps. - Based on FGBuster. - - Returns - ------- - dict_comps: dict - Dictionary containing the component instances. - - """ - - components = [] - components_name = [] - - if self.preset_tools.params["CMB"]["cmb"]: - components += [c.CMB()] - components_name += ["CMB"] - - if self.preset_tools.params["Foregrounds"]["Dust"][f"Dust_{key}"]: - components += [ - c.Dust( - nu0=self.preset_tools.params["Foregrounds"]["Dust"]["nu0_d"], - temp=20, - beta_d=None, - ) - ] - components_name += ["Dust"] - - if self.preset_tools.params["Foregrounds"]["Synchrotron"][f"Synchrotron_{key}"]: - components += [ - c.Synchrotron( - nu0=self.preset_tools.params["Foregrounds"]["Synchrotron"]["nu0_s"] - ) - ] - components_name += ["Synchrotron"] - - if self.preset_tools.params["Foregrounds"]["CO"][f"CO_{key}"]: - components += [ - c.COLine( - nu=self.preset_tools.params["Foregrounds"]["CO"]["nu0_co"], - active=False, - ) - ] - components_name += ["CO"] - - return components, components_name
-
- -
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/CMM/preset/preset_sky.html b/docs/_build/html/_modules/CMM/preset/preset_sky.html deleted file mode 100644 index ad54d85..0000000 --- a/docs/_build/html/_modules/CMM/preset/preset_sky.html +++ /dev/null @@ -1,277 +0,0 @@ - - - - - - CMM.preset.preset_sky — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for CMM.preset.preset_sky

-import healpy as hp
-import numpy as np
-import qubic
-from pysimulators.interfaces.healpy import HealpixConvolutionGaussianOperator
-from qubic import NamasterLib as nam
-
-
-
-[docs] -class PresetSky: - r"""Preset Sky. - - Instance to initialize the Components Map-Making. It defines the observed sky variables and methods. - - Parameters - ---------- - preset_tools : object - Class containing tools and simulation parameters. - preset_qubic : object - Class containing qubic operator and variables and methods. - - Attributes - ---------- - center: tuple - Defines the center of the QUBIC observation patch in (RA, DEC). - coverage: array_like - Defines the coverage of the QUBIC scanning strategy. - max_coverage: float - Defines the maximum of the coverage. - seenpix_qubic: array_like - Boolean array defining the pixels seen by QUBIC instrument. - seenpix: array_like - Boolean array defining the pixel with coverage > at a threshold chosen in params.yml. - namaster: object - NaMaster class instance. - ell: array_like - Multipole array, defining through NaMaster. - cl2dl: array_like - Array containing conversion factor to compute :math:`D_{\ell}` from :math:`C_{\ell}`. - - """ - - def __init__(self, preset_tools, preset_qubic): - """ - Initialize. - - """ - ### Import preset tools - self.preset_tools = preset_tools - - ### Define variable for SKY parameters - self.params_sky = self.preset_tools.params["SKY"] - - ### Center of the QUBIC patch - self.preset_tools._print_message(" => Getting center of the QUBIC patch") - self.center = qubic.equ2gal( - self.params_sky["RA_center"], self.params_sky["DEC_center"] - ) - - ### Compute coverage map - self.preset_tools._print_message(" => Computing coverage") - self.coverage = preset_qubic.joint_out.qubic.coverage - self.max_coverage = np.max(self.coverage) - - ### Compute seen pixels - self.preset_tools._print_message(" => Computing cut between Planck & QUBIC") - - # All the pixels seen by QUBIC - self.seenpix_qubic = self.coverage / self.max_coverage > 0 - self.seenpix_015 = self.coverage / self.max_coverage > 0.15 - - # Pixels seen enough by QUBIC, according to the threshold defined in params.yml. The others will be replaced by Planck - self.seenpix = ( - self.coverage / self.max_coverage - > self.preset_tools.params["PLANCK"]["thr_planck"] - ) - - ### Define the map of betas across the patch if 'nside_beta_out' != 0 - if self.preset_tools.params["Foregrounds"]["Dust"]["nside_beta_out"] != 0: - # Build super-pixels seen by QUBIC from maps pixels - self.seenpix_beta = hp.ud_grade( - self.seenpix, - self.preset_tools.params["Foregrounds"]["Dust"]["nside_beta_out"], - ) - # Compute their coverage - self.coverage_beta = self.get_coverage() - else: - self.coverage_beta = None - - ### Build mask for weighted Planck data - self.preset_tools._print_message(" => Creating mask") - self.mask = np.ones(12 * self.params_sky["nside"] ** 2) - self.mask[self.seenpix] = self.preset_tools.params["PLANCK"]["weight_planck"] - C = HealpixConvolutionGaussianOperator( - fwhm=self.preset_tools.params["PLANCK"]["fwhm_weight_planck"], - lmax=3 * self.params_sky["nside"], - ) - self.mask = C(self.mask) - - ### Initialize namaster - self.preset_tools._print_message(" => Initializing Namaster") - self.get_spectra_namaster_informations() - -
-[docs] - def get_coverage(self): - """Coverage. - - Calculate the coverage mask for the QUBIC patch, according with the number of beta that you want to reconstruct. - - This function computes the angular distance between a center point and all - pixels on a sphere, sorts these distances, and creates a mask that marks - the closest pixels as covered. - - Returns - ------- - mask: array_like - A mask array where covered pixels are marked with 1 and uncovered pixels are marked with 0. - - """ - - vec_center = np.array(hp.ang2vec(self.center[0], self.center[1], lonlat=True)) - vec_pix = np.array( - hp.pix2vec( - self.preset_tools.params["Foregrounds"]["Dust"]["nside_beta_out"], - np.arange( - 12 - * self.preset_tools.params["Foregrounds"]["Dust"]["nside_beta_out"] - ** 2 - ), - ) - ) - - angle = np.arccos(np.dot(vec_center, vec_pix)) - indices = np.argsort(angle) - - mask = np.zeros( - 12 * self.preset_tools.params["Foregrounds"]["Dust"]["nside_beta_out"] ** 2 - ) - pix_inside_patch = indices[ - : self.preset_tools.params["Foregrounds"]["Dust"]["nside_beta_in"] - ] - mask[pix_inside_patch] = 1 - - return mask
- - -
-[docs] - def get_spectra_namaster_informations(self): - """NaMaster. - - Initializes the Namaster object and computes the ell and cl2dl arrays. - - This method sets up the Namaster object using parameters from the preset_tools - and computes the ell array and cl2dl conversion factor for power spectrum analysis. - - """ - - self.namaster = nam.Namaster( - self.seenpix, - lmin=self.preset_tools.params["SPECTRUM"]["lmin"], - lmax=3 * self.preset_tools.params["SKY"]["nside"], - delta_ell=self.preset_tools.params["SPECTRUM"]["dl"], - aposize=self.preset_tools.params["SPECTRUM"]["aposize"], - ) - self.ell, _ = self.namaster.get_binning( - self.preset_tools.params["SKY"]["nside"] - ) - self.cl2dl = self.ell * (self.ell + 1) / (2 * np.pi)
-
- -
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/CMM/preset/preset_tools.html b/docs/_build/html/_modules/CMM/preset/preset_tools.html deleted file mode 100644 index 03bf216..0000000 --- a/docs/_build/html/_modules/CMM/preset/preset_tools.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - CMM.preset.preset_tools — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for CMM.preset.preset_tools

-import os
-
-import yaml
-
-
-
-[docs] -class PresetTools: - """Preset Tools. - - Instance to initialize the Components Map-Making. It contains tool functions used in all the different files and the simulation parameters. - - Parameters - ---------- - comm: MPI communicator - MPI common communicator define by MPI.COMM_WORLD. - - Attributes - ---------- - params: dict - Dictionary containing all the simulations parameters. - - """ - - def __init__(self, comm): - """ - Initialize. - - """ - - ### MPI common arguments - self.comm = comm - self.rank = self.comm.Get_rank() - self.size = self.comm.Get_size() - - ### Open parameters file - self._print_message("========= Initialization =========") - self._print_message(" => Reading parameters file") - with open("src/CMM/params.yml", "r") as stream: - self.params = yaml.safe_load(stream) - - def _print_message(self, message): - """ - Display a `message` only for the first rank in an MPI multiprocessing environment. - - Parameters: - message (str): The message to be displayed. - - Returns: - None - """ - if self.rank == 0: - print(message) - -
-[docs] - def create_folder_if_not_exists(self, folder_name): - """Create folder. - - Creates a folder with the specified name if it does not already exist. - - Parameters - ---------- - folder_name: str - The name of the folder to create. - - """ - - # Check if the folder exists - if not os.path.exists(folder_name): - try: - # Create the folder if it doesn't exist - os.makedirs(folder_name) - print(f"The folder '{folder_name}' has been created.") - except OSError as e: - print(f"Error creating the folder '{folder_name}': {e}") - else: - pass
- - -
-[docs] - def check_for_errors(self): - """Errors check. - - Checks for various parameter errors in the 'params.yml' file. - - Raises: - TypeError: If any of the parameter checks fail. - - """ - - # Check if the instrument is either 'DB' or 'UWB' - if self.params["QUBIC"]["instrument"] not in ["DB", "UWB"]: - raise TypeError("You must choose DB or UWB instrument") - - # Check if bin_mixing_matrix is even - if self.params["Foregrounds"]["bin_mixing_matrix"] % 2 != 0: - raise TypeError("The argument bin_mixing_matrix should be even") - - # Check if nsub_in is even - if self.params["QUBIC"]["nsub_in"] % 2 != 0: - raise TypeError("The argument nsub_in should be even") - - # Check if nsub_out is even - if self.params["QUBIC"]["nsub_out"] % 2 != 0: - raise TypeError("The argument nsub_out should be even") - - # Check if blind_method is one of the allowed methods - if self.params["Foregrounds"]["blind_method"] not in [ - "alternate", - "minimize", - "PCG", - ]: - raise TypeError("You must choose alternate, minimize or PCG method") - - # Check if nsub_out is greater than or equal to bin_mixing_matrix - if ( - self.params["QUBIC"]["nsub_out"] - < self.params["Foregrounds"]["bin_mixing_matrix"] - ): - raise TypeError("nsub_out should be higher than bin_mixing_matrix") - - # Check if bin_mixing_matrix is a multiple of nsub_out when either Dust or Synchrotron type is 'blind' - if ( - self.params["Foregrounds"]["Dust"]["type"] == "blind" - or self.params["Foregrounds"]["Synchrotron"]["type"] == "blind" - ): - if ( - self.params["QUBIC"]["nsub_out"] - % self.params["Foregrounds"]["bin_mixing_matrix"] - != 0 - ): - raise TypeError("bin_mixing_matrix should be a multiple of nsub_out") - - # Check if nside_beta is a multiple of 2 for d1 case - if ( - self.params["Foregrounds"]["Dust"]["model_d"] == "d1" - and self.params["Foregrounds"]["Dust"]["nside_beta_in"] % 2 != 0 - ): - if self.params["Foregrounds"]["Dust"]["nside_beta_in"] <= 0: - raise TypeError( - "nside_beta should be a multiple of two > 0 for d1 Dust model" - ) - - if ( - self.params["Foregrounds"]["Dust"]["model_d"] == "d1" - and self.params["Foregrounds"]["Dust"]["type"] == "blind" - ): - raise TypeError("Blind method is not implemented for d1 model") - - if ( - self.params["PCG"]["fixI"] - and self.params["PCG"]["fix_pixels_outside_patch"] - ): - raise TypeError( - "fixI and fix_pixels_outside_patch can't be yet mixed together" - )
- - -
-[docs] - def display_simulation_configuration(self): - """ - Display the simulation configuration details. - - This method prints out the configuration settings for the simulation, including - details about the sky input and output, QUBIC instrument settings, and MPI tasks. - The configuration is only displayed if the rank of the process is 0. - """ - if self.rank == 0: - print("******************** Configuration ********************\n") - print(" - QUBIC :") - print(f" Npointing : {self.params['QUBIC']['npointings']}") - print(f" Nsub : {self.params['QUBIC']['nsub_in']}") - print(f" Ndet : {self.params['QUBIC']['NOISE']['ndet']}") - print(f" Npho150 : {self.params['QUBIC']['NOISE']['npho150']}") - print(f" Npho220 : {self.params['QUBIC']['NOISE']['npho220']}") - print(f" RA : {self.params['SKY']['RA_center']}") - print(f" DEC : {self.params['SKY']['DEC_center']}") - if self.params["QUBIC"]["instrument"] == "DB": - print(f" Type : Dual Bands") - else: - print(f" Type : Ultra Wide Band") - print(" - Sky In :") - print(f" CMB : {self.params['CMB']['cmb']}") - print( - f" Dust : {self.params['Foregrounds']['Dust']['Dust_in']} - {self.params['Foregrounds']['Dust']['model_d']}" - ) - print( - f" Synchrotron : {self.params['Foregrounds']['Synchrotron']['Synchrotron_in']} - {self.params['Foregrounds']['Synchrotron']['model_s']}" - ) - print(f" CO : {self.params['Foregrounds']['CO']['CO_in']}\n") - print(" - Sky Out :") - print(f" CMB : {self.params['CMB']['cmb']}") - print( - f" Dust : {self.params['Foregrounds']['Dust']['Dust_out']} - {self.params['Foregrounds']['Dust']['model_d']}" - ) - print( - f" Synchrotron : {self.params['Foregrounds']['Synchrotron']['Synchrotron_out']} - {self.params['Foregrounds']['Synchrotron']['model_s']}" - ) - print(f" CO : {self.params['Foregrounds']['CO']['CO_out']}\n") - - print(f" MPI Tasks : {self.size}")
- - - def _display_iter(self, steps): - """ - Display the number of a specific iteration k only for the first rank in an MPI multiprocessing environment. - - Args: - steps (int): Iteration number. - """ - - if self.rank == 0: - print( - "========== Iter {}/{} ==========".format( - steps + 1, self.params["PCG"]["n_iter_loop"] - ) - )
- -
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/FMM/pipeline.html b/docs/_build/html/_modules/FMM/pipeline.html deleted file mode 100644 index 949ba28..0000000 --- a/docs/_build/html/_modules/FMM/pipeline.html +++ /dev/null @@ -1,1126 +0,0 @@ - - - - - - FMM.pipeline — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for FMM.pipeline

-### General packages
-import os
-import pickle
-import time
-
-import numpy as np
-import qubic
-import yaml
-from pysimulators.interfaces.healpy import HealpixConvolutionGaussianOperator
-
-### Local packages
-from lib.Qacquisition import *
-from lib.Qcg import *
-from lib.Qcomponent_model import *
-from lib.Qfoldertools import *
-from lib.Qmap_plotter import *
-from lib.Qnoise import *
-from lib.Qspectra import *
-
-from .model.externaldata import *
-from .model.models import *
-from .model.planck_timeline import *
-
-
-def save_pkl(name, d):
-    """
-    Function that create a file called "name" to save the dictionary "d" using Pickle package
-
-    Parameters
-    ----------
-    name : string
-        file name
-    d : dict
-        dictionary saved using Pickle
-    """
-    with open(name, "wb") as handle:
-        pickle.dump(d, handle, protocol=pickle.HIGHEST_PROTOCOL)
-
-
-__all__ = ["PipelineFrequencyMapMaking", "PipelineEnd2End"]
-
-
-
-[docs] -class PipelineFrequencyMapMaking: - """ - Instance to reconstruct frequency maps using QUBIC abilities. - - Parameters - ---------- - comm : - MPI communicator - file : str - used to create the forlder for data saving - params : dict - dictionary containing all the simulation parameters - - """ - - - def __init__(self, comm, file, params): - """ - Initialise PipelineFrequencyMapMaking - - """ - - self.mapmaking_time_0 = time.time() - - self.params = params - - ### Fsub - self.fsub = int(self.params["QUBIC"]["nsub_out"] / self.params["QUBIC"]["nrec"]) - - self.file = file - self.plot_folder = "src/FMM/" + self.params["path_out"] + "png/" - - self.externaldata = PipelineExternalData(file, self.params) - self.externaldata.run(fwhm=self.params["QUBIC"]["convolution_in"], noise=True) - - self.externaldata_noise = PipelineExternalData( - file, self.params, noise_only=True - ) - self.externaldata_noise.run( - fwhm=self.params["QUBIC"]["convolution_in"], noise=True - ) - - if comm.Get_rank() == 0: - if not os.path.isdir("src/FMM/" + self.params["path_out"] + "maps/"): - os.makedirs("src/FMM/" + self.params["path_out"] + "maps/") - if not os.path.isdir("src/FMM/" + self.params["path_out"] + "png/"): - os.makedirs("src/FMM/" + self.params["path_out"] + "png/") - - self.job_id = os.environ.get("SLURM_JOB_ID") - self.center = qubic.equ2gal( - self.params["SKY"]["RA_center"], self.params["SKY"]["DEC_center"] - ) - - ### MPI common arguments - self.comm = comm - self.size = self.comm.Get_size() - self.rank = self.comm.Get_rank() - - ### Sky - self.dict_in, self.dict_mono_in = self.get_dict(key="in") - self.dict_out, self.dict_mono_out = self.get_dict(key="out") - self.skyconfig = self.get_sky_config() - - ### Initial maps - self.m_nu_in = self.get_input_map() - - ### Joint acquisition for TOD making - self.joint_tod = JointAcquisitionFrequencyMapMaking( - self.dict_in, - self.params["QUBIC"]["instrument"], - self.params["QUBIC"]["nsub_in"], - self.params["QUBIC"]["nsub_in"], - H=None, - ) - - ### Joint acquisition - if self.params["QUBIC"]["nsub_in"] == self.params["QUBIC"]["nsub_out"]: - H = self.joint_tod.qubic.H - else: - H = None - - self.joint = JointAcquisitionFrequencyMapMaking( - self.dict_out, - self.params["QUBIC"]["instrument"], - self.params["QUBIC"]["nrec"], - self.params["QUBIC"]["nsub_out"], - H=H, - ) - - self.planck_acquisition143 = PlanckAcquisition(143, self.joint.qubic.scene) - self.planck_acquisition217 = PlanckAcquisition(217, self.joint.qubic.scene) - self.nus_Q = self.get_averaged_nus() - - ### Coverage map - self.coverage = self.joint.qubic.subacqs[0].get_coverage() - covnorm = self.coverage / self.coverage.max() - self.seenpix = covnorm > self.params["SKY"]["coverage_cut"] - self.seenpix_qubic = covnorm > 0 - self.fsky = self.seenpix.astype(float).sum() / self.seenpix.size - self.coverage_cut = self.coverage.copy() - self.coverage_cut[~self.seenpix] = 1 - - self.seenpix_for_plot = covnorm > 0 - self.mask = np.ones(12 * self.params["SKY"]["nside"] ** 2) - self.mask[self.seenpix] = self.params["PLANCK"]["weight_planck"] - - ### Angular resolutions - self.fwhm_in, self.fwhm_out, self.fwhm_rec = self.get_convolution() - - self.external_timeline = ExternalData2Timeline( - self.skyconfig, - self.joint.qubic.allnus, - self.params["QUBIC"]["nrec"], - nside=self.params["SKY"]["nside"], - corrected_bandpass=self.params["QUBIC"]["bandpass_correction"], - ) - - ### Define reconstructed and TOD operator - self.get_H() - - ### Inverse noise covariance matrix - self.invN = self.joint.get_invntt_operator(mask=self.mask) - - ### Noises - seed_noise_planck = self.get_random_value() - - self.noise143 = ( - self.planck_acquisition143.get_noise(seed_noise_planck) - * self.params["PLANCK"]["level_noise_planck"] - ) - self.noise217 = ( - self.planck_acquisition217.get_noise(seed_noise_planck + 1) - * self.params["PLANCK"]["level_noise_planck"] - ) - - if self.params["QUBIC"]["instrument"] == "DB": - qubic_noise = QubicDualBandNoise( - self.dict_out, - self.params["QUBIC"]["npointings"], - self.params["QUBIC"]["NOISE"]["detector_nep"], - ) - elif self.params["QUBIC"]["instrument"] == "UWB": - qubic_noise = QubicWideBandNoise( - self.dict_out, - self.params["QUBIC"]["npointings"], - self.params["QUBIC"]["NOISE"]["detector_nep"], - ) - - self.noiseq = qubic_noise.total_noise( - self.params["QUBIC"]["NOISE"]["ndet"], - self.params["QUBIC"]["NOISE"]["npho150"], - self.params["QUBIC"]["NOISE"]["npho220"], - seed_noise=seed_noise_planck, - ).ravel() - - ### Initialize plot instance - self.plots = PlotsFMM(self.seenpix) - -
-[docs] - def get_components_fgb(self): - """Components FGbuster - - Method to build a dictionary containing all the wanted components to generate sky maps. - Based on FGBuster. - - Returns - ------- - dict_comps: dict - Dictionary containing the component instances. - - """ - - dict_comps = [] - - if self.params["CMB"]["cmb"]: - dict_comps += [CMB()] - - if self.params["Foregrounds"]["Dust"]: - dict_comps += [Dust(nu0=150, beta_d=1.54, temp=20)] - - if self.params["Foregrounds"]["Synchrotron"]: - dict_comps += [Synchrotron(nu0=150, beta_pl=-3)] - - return dict_comps
- - -
-[docs] - def get_random_value(self): - """Random value - - Method to build a random seed. - - Returns - ------- - seed: int - Random seed. - - """ - - np.random.seed(None) - if self.rank == 0: - seed = np.random.randint(10000000) - else: - seed = None - - seed = self.comm.bcast(seed, root=0) - return seed
- - -
-[docs] - def get_H(self): - """Acquisition operator - - Method to compute QUBIC acquisition operators. - - """ - - ### Pointing matrix for TOD generation - self.H_in = self.joint_tod.get_operator( - fwhm=self.fwhm_in - ) # , external_data=self.params['PLANCK']['external_data']) - - ### QUBIC Pointing matrix for TOD generation - self.H_in_qubic = self.joint_tod.qubic.get_operator(fwhm=self.fwhm_in) - - ### Pointing matrix for reconstruction - self.H_out_all_pix = self.joint.get_operator(fwhm=self.fwhm_out) - self.H_out = self.joint.get_operator( - fwhm=self.fwhm_out, seenpix=self.seenpix - ) # , external_data=self.params['PLANCK']['external_data'])
- - -
-[docs] - def get_averaged_nus(self): - """Average frequency - - Method to average QUBIC frequencies according to the number of reconstructed frequency maps. - - Returns - ------- - nus_ave: array_like - array containing the averaged QUBIC frequencies. - - """ - - nus_ave = [] - for i in range(self.params["QUBIC"]["nrec"]): - nus_ave += [ - np.mean(self.joint.qubic.allnus[i * self.fsub : (i + 1) * self.fsub]) - ] - - return np.array(nus_ave)
- - -
-[docs] - def get_sky_config(self): - """Sky configuration. - - Method that read 'params.yml' file and create dictionary containing sky emission model. - - Returns - ------- - dict_sky: dict - Sky config dictionary. - - Notes - ----- - Note that the key denote the emission and the value denote the sky model using PySM convention. - For CMB, seed denote the realization. - - Example - ------- - d = {'cmb':seed, 'dust':'d0', 'synchrotron':'s0'} - - """ - - dict_sky = {} - - if self.params["CMB"]["cmb"]: - if self.params["CMB"]["seed"] == 0: - if self.rank == 0: - seed = np.random.randint(10000000) - else: - seed = None - seed = self.comm.bcast(seed, root=0) - else: - seed = self.params["CMB"]["seed"] - print(f"Seed of the CMB is {seed} for rank {self.rank}") - dict_sky["cmb"] = seed - - for j in self.params["Foregrounds"]: - # print(j, self.params['Foregrounds'][j]) - if j == "Dust": - if self.params["Foregrounds"][j]: - dict_sky["dust"] = "d0" - elif j == "Synchrotron": - if self.params["Foregrounds"][j]: - dict_sky["synchrotron"] = "s0" - - return dict_sky
- - -
-[docs] - def get_dict(self, key="in"): - """QUBIC dictionary. - - Method to modify the qubic dictionary. - - Parameters - ---------- - key : str, optional - Can be "in" or "out". - It is used to build respectively the instances to generate the TODs or to reconstruct the sky maps, - by default "in". - - Returns - ------- - dict_qubic: dict - Modified QUBIC dictionary. - - """ - - args = { - "npointings": self.params["QUBIC"]["npointings"], - "nf_recon": self.params["QUBIC"]["nrec"], - "nf_sub": self.params["QUBIC"][f"nsub_{key}"], - "nside": self.params["SKY"]["nside"], - "MultiBand": True, - "period": 1, - "RA_center": self.params["SKY"]["RA_center"], - "DEC_center": self.params["SKY"]["DEC_center"], - "filter_nu": 150 * 1e9, - "noiseless": False, - "comm": self.comm, - "dtheta": self.params["QUBIC"]["dtheta"], - "nprocs_sampling": 1, - "nprocs_instrument": self.size, - "photon_noise": True, - "nhwp_angles": 3, - #'effective_duration':3, - "effective_duration150": 3, - "effective_duration220": 3, - "filter_relative_bandwidth": 0.25, - "type_instrument": "wide", - "TemperatureAtmosphere150": None, - "TemperatureAtmosphere220": None, - "EmissivityAtmosphere150": None, - "EmissivityAtmosphere220": None, - "detector_nep": float(self.params["QUBIC"]["NOISE"]["detector_nep"]), - "synthbeam_kmax": self.params["QUBIC"]["SYNTHBEAM"]["synthbeam_kmax"], - } - - ### Get the default dictionary - dictfilename = "dicts/pipeline_demo.dict" - dict_qubic = qubic.qubicdict.qubicDict() - dict_qubic.read_from_file(dictfilename) - - for i in args.keys(): - - dict_qubic[str(i)] = args[i] - - return dict_qubic
- - -
-[docs] - def get_convolution(self): - """QUBIC resolutions. - - Method to define expected QUBIC angular resolutions (radians) as function of frequencies. - - Returns - ------- - fwhm_in: array_like - Intrinsic resolutions, used to build the simulated TOD. - fwhm_out: array_like - Output resolutions. If we don't apply convolutions during reconstruction, array of zeros. - fwhm_rec: array_like - Reconstructed resolutions. Egal the output resolutions if we apply convolutions during reconstructions, evaluate through analytic formula otherwise. - - """ - - ### Define FWHMs - - fwhm_in = None - fwhm_out = None - - ### FWHMs during map-making - if self.params["QUBIC"]["convolution_in"]: - fwhm_in = self.joint.qubic.allfwhm.copy() - if self.params["QUBIC"]["convolution_out"]: - fwhm_out = np.array([]) - for irec in range(self.params["QUBIC"]["nrec"]): - fwhm_out = np.append( - fwhm_out, - np.sqrt( - self.joint.qubic.allfwhm[ - irec * self.fsub : (irec + 1) * self.fsub - ] - ** 2 - - np.min( - self.joint.qubic.allfwhm[ - irec * self.fsub : (irec + 1) * self.fsub - ] - ) - ** 2 - ), - ) - - ### Define reconstructed FWHM depending on the user's choice - if ( - self.params["QUBIC"]["convolution_in"] - and self.params["QUBIC"]["convolution_out"] - ): - fwhm_rec = np.array([]) - for irec in range(self.params["QUBIC"]["nrec"]): - fwhm_rec = np.append( - fwhm_rec, - np.min( - self.joint.qubic.allfwhm[ - irec * self.fsub : (irec + 1) * self.fsub - ] - ), - ) - - elif ( - self.params["QUBIC"]["convolution_in"] - and self.params["QUBIC"]["convolution_out"] is False - ): - fwhm_rec = np.array([]) - for irec in range(self.params["QUBIC"]["nrec"]): - fwhm_rec = np.append( - fwhm_rec, - np.mean( - self.joint.qubic.allfwhm[ - irec * self.fsub : (irec + 1) * self.fsub - ] - ), - ) - - else: - fwhm_rec = np.array([]) - for irec in range(self.params["QUBIC"]["nrec"]): - fwhm_rec = np.append(fwhm_rec, 0) - - if self.rank == 0: - print(f"FWHM for TOD generation : {fwhm_in}") - print(f"FWHM for reconstruction : {fwhm_out}") - print(f"Final FWHM : {fwhm_rec}") - - return fwhm_in, fwhm_out, fwhm_rec
- - -
-[docs] - def get_input_map(self): - r"""Input maps. - - Function to get the input maps from PySM3. - - Returns - ------- - maps_in: array_like - Input maps :math:`(N_{rec}, 12 \times N^{2}_{side}, N_{stk})`. - - """ - - m_nu_in = np.zeros( - (self.params["QUBIC"]["nrec"], 12 * self.params["SKY"]["nside"] ** 2, 3) - ) - - for i in range(self.params["QUBIC"]["nrec"]): - m_nu_in[i] = np.mean( - self.external_timeline.m_nu[i * self.fsub : (i + 1) * self.fsub], axis=0 - ) - - return m_nu_in
- - -
-[docs] - def get_tod(self, noise=False): - r"""Simulated TOD. - - Method that compute observed TODs with :math:`\vec{TOD} = H \cdot \vec{s} + \vec{n}`, with H the QUBIC operator, :math:`\vec{s}` the sky signal and :math:`\vec{n}` the instrumental noise`. - - Parameters - ---------- - noise : bool, optional - True if you want to simulate noise in your data, False otherwise, by default False. - - Returns - ------- - TOD: array_like - Simulated TOD :math:`(N_{rec}, 12 \times N^{2}_{side}, N_{stk})`. - - """ - - if noise: - factor = 0 - else: - factor = 1 - if self.params["QUBIC"]["instrument"] == "UWB": - if self.params["QUBIC"]["nrec"] != 1: - TOD_PLANCK = np.zeros( - ( - self.params["QUBIC"]["nrec"], - 12 * self.params["SKY"]["nside"] ** 2, - 3, - ) - ) - for irec in range(int(self.params["QUBIC"]["nrec"] / 2)): - if self.params["QUBIC"]["convolution_in"]: - C = HealpixConvolutionGaussianOperator( - fwhm=np.min( - self.fwhm_in[irec * self.fsub : (irec + 1) * self.fsub] - ) - ) - - else: - C = HealpixConvolutionGaussianOperator(fwhm=0) - - TOD_PLANCK[irec] = C( - factor * self.external_timeline.maps[irec] + self.noise143 - ) - - for irec in range( - int(self.params["QUBIC"]["nrec"] / 2), self.params["QUBIC"]["nrec"] - ): - if self.params["QUBIC"]["convolution_in"]: - C = HealpixConvolutionGaussianOperator( - fwhm=np.min( - self.fwhm_in[irec * self.fsub : (irec + 1) * self.fsub] - ) - ) - - else: - C = HealpixConvolutionGaussianOperator(fwhm=0) - - TOD_PLANCK[irec] = C( - factor * self.external_timeline.maps[irec] + self.noise217 - ) - else: - TOD_PLANCK = np.zeros( - ( - 2 * self.params["QUBIC"]["nrec"], - 12 * self.params["SKY"]["nside"] ** 2, - 3, - ) - ) - - if self.params["QUBIC"]["convolution_in"]: - C = HealpixConvolutionGaussianOperator(fwhm=self.fwhm_in[-1]) - else: - C = HealpixConvolutionGaussianOperator(fwhm=0) - - TOD_PLANCK[0] = C( - factor * self.external_timeline.maps[0] + self.noise143 - ) - TOD_PLANCK[1] = C( - factor * self.external_timeline.maps[0] + self.noise217 - ) - - TOD_PLANCK = TOD_PLANCK.ravel() - TOD_QUBIC = ( - self.H_in_qubic(factor * self.external_timeline.m_nu).ravel() - + self.noiseq - ) - if self.params["PLANCK"]["external_data"]: - TOD = np.r_[TOD_QUBIC, TOD_PLANCK] - else: - TOD = TOD_QUBIC - - else: - - sh_q = self.joint.qubic.ndets * self.joint.qubic.nsamples - TOD_QUBIC = ( - self.H_in_qubic(factor * self.external_timeline.m_nu).ravel() - + self.noiseq - ) - if self.params["PLANCK"]["external_data"] == False: - TOD = TOD_QUBIC - else: - TOD_QUBIC150 = TOD_QUBIC[:sh_q].copy() - TOD_QUBIC220 = TOD_QUBIC[sh_q:].copy() - - TOD = TOD_QUBIC150.copy() - TOD_PLANCK = np.zeros( - ( - self.params["QUBIC"]["nrec"], - 12 * self.params["SKY"]["nside"] ** 2, - 3, - ) - ) - for irec in range(int(self.params["QUBIC"]["nrec"] / 2)): - if self.params["QUBIC"]["convolution_in"]: - C = HealpixConvolutionGaussianOperator( - fwhm=np.min( - self.fwhm_in[irec * self.fsub : (irec + 1) * self.fsub] - ) - ) - - else: - C = HealpixConvolutionGaussianOperator(fwhm=0) - - TOD = np.r_[ - TOD, - C( - factor * self.external_timeline.maps[irec] + self.noise143 - ).ravel(), - ] - - TOD = np.r_[TOD, TOD_QUBIC220.copy()] - for irec in range( - int(self.params["QUBIC"]["nrec"] / 2), self.params["QUBIC"]["nrec"] - ): - if self.params["QUBIC"]["convolution_in"]: - C = HealpixConvolutionGaussianOperator( - fwhm=np.min( - self.fwhm_in[irec * self.fsub : (irec + 1) * self.fsub] - ) - ) - - else: - C = HealpixConvolutionGaussianOperator(fwhm=0) - - TOD = np.r_[ - TOD, - C( - factor * self.external_timeline.maps[irec] + self.noise217 - ).ravel(), - ] - - return TOD
- - - def _barrier(self): - """ - Method to introduce comm._Barrier() function if MPI communicator is detected. - - """ - if self.comm is None: - pass - else: - self.comm._Barrier() - - def _print_message(self, message): - """ - Method to print message only on rank 0 if MPI communicator is detected. It display simple message if not. - - """ - - if self.comm is None: - print(message) - else: - if self.rank == 0: - print(message) - -
-[docs] - def get_preconditioner(self): - """PCG Preconditioner. - - Computed using the formula: To be added. - - Returns - ------- - M: DiagonalOperator - Preconditioner for PCG algorithm. - """ - - if self.params["PCG"]["preconditioner"]: - - approx_hth = np.zeros( - ( - self.params["QUBIC"]["nsub_out"], - 12 * self.params["SKY"]["nside"] ** 2, - 3, - ) - ) - conditioner = np.zeros( - (self.params["QUBIC"]["nrec"], 12 * self.params["SKY"]["nside"] ** 2, 3) - ) - vec = np.ones(self.joint.qubic.H[0].shapein) - - for i in range(self.params["QUBIC"]["nsub_out"]): - for j in range(self.params["QUBIC"]["nsub_out"]): - approx_hth[i] = ( - self.joint.qubic.H[i].T - * self.joint.qubic.invn220 - * self.joint.qubic.H[j](vec) - ) - - for irec in range(self.params["QUBIC"]["nrec"]): - imin = irec * self.fsub - imax = (irec + 1) * self.fsub - for istk in range(3): - conditioner[irec, self.seenpix, istk] = 1 / ( - np.sum(approx_hth[imin:imax, self.seenpix, 0], axis=0) - ) - - conditioner[conditioner == np.inf] = 1 - - M = DiagonalOperator(conditioner[:, self.seenpix, :]) - else: - M = None - return M
- - -
-[docs] - def pcg(self, d, x0, seenpix): - r"""Preconditioned Conjugate Gradiant algorithm. - - Solve the map-making equation iteratively : :math:`(H^T . N^{-1} . H) . x = H^T . N^{-1} . d`. - - The PCG used for the minimization is intrinsequely parallelized (e.g see PyOperators). - - Parameters - ---------- - d : array_like - Array containing the TODs generated previously :math:`(N_{rec}, 12 \times N^{2}_{side}, N_{stk})`. - x0 : array_like - Starting point of the PCG algorithm :math:`(N_{rec}, 12 \times N^{2}_{side}, N_{stk})`. - seenpix : array_like - Boolean array to define the pixels seen by QUBIC :math:`(N_{rec}, 12 \times N^{2}_{side}, N_{stk})`. - - Returns - ------- - solution: array_like - Reconstructed maps :math:`(N_{rec}, 12 \times N^{2}_{side}, N_{stk})`. - - """ - - ### Update components when pixels outside the patch are fixed (assumed to be 0) - A = self.H_out.T * self.invN * self.H_out - - x_planck = self.m_nu_in * (1 - seenpix[None, :, None]) - b = self.H_out.T * self.invN * (d - self.H_out_all_pix(x_planck)) - ### Preconditionning - M = self.get_preconditioner() - - if self.params["PCG"]["gif"]: - gif_folder = self.plot_folder + f"{self.job_id}/iter/" - else: - gif_folder = None - - ### PCG - solution_qubic_planck = pcg( - A=A, - b=b, - comm=self.comm, - x0=x0, - M=M, - tol=self.params["PCG"]["tolpcg"], - disp=True, - maxiter=self.params["PCG"]["n_iterpcg"], - gif_folder=gif_folder, - job_id=self.job_id, - seenpix=self.seenpix, - seenpix_plot=self.seenpix, - center=self.center, - reso=self.params["PCG"]["resolution_plot"], - fwhm_plot=self.params["PCG"]["fwhm_plot"], - input=self.m_nu_in, - ) - - if self.params["PCG"]["gif"]: - do_gif(gif_folder, "iter_", output="animation.gif") - - self._barrier() - - if self.params["QUBIC"]["nrec"] == 1: - solution_qubic_planck["x"]["x"] = np.array( - [solution_qubic_planck["x"]["x"]] - ) - - solution = np.ones(self.m_nu_in.shape) * hp.UNSEEN - solution[:, seenpix, :] = solution_qubic_planck["x"]["x"].copy() - - return solution
- - - def _save_data(self, name, d): - """ - Method to save data using pickle convention. - - """ - - with open(name, "wb") as handle: - pickle.dump(d, handle, protocol=pickle.HIGHEST_PROTOCOL) - -
-[docs] - def run(self): - """Run the FMM Pipeline. - - Method to run the whole pipeline from TOD generation from sky reconstruction by reading `params.yml` file. - - """ - - self._print_message("\n=========== Map-Making ===========\n") - - ### Get simulated data - self.TOD = self.get_tod(noise=False) - self.n = self.get_tod(noise=True) - - ### Wait for all processes - self._barrier() - - if self.params["QUBIC"]["convolution_in"]: - for i in range(self.params["QUBIC"]["nrec"]): - C = HealpixConvolutionGaussianOperator(fwhm=self.fwhm_rec[i]) - self.m_nu_in[i] = C(self.m_nu_in[i]) - - x0 = self.m_nu_in.copy() - x0[:, self.seenpix, :] = 0 - - ### Solve map-making equation - self.s_hat = self.pcg( - self.TOD, x0=x0[:, self.seenpix, :], seenpix=self.seenpix - ) - - ### Wait for all processes - self._barrier() - - ### n = m_signalnoisy - m_signal - self.s_hat_noise = self.s_hat - self.m_nu_in - - ### Ensure that non seen pixels is 0 for spectrum computation - self.s_hat[:, ~self.seenpix, :] = 0 - self.s_hat_noise[:, ~self.seenpix, :] = 0 - - ### Plots and saving - if self.rank == 0: - - self.external_maps = self.externaldata.maps.copy() - self.external_maps[:, ~self.seenpix, :] = 0 - - self.external_maps_noise = self.externaldata_noise.maps.copy() - self.external_maps_noise[:, ~self.seenpix, :] = 0 - - if len(self.externaldata.external_nus) != 0: - fwhm_ext = self.externaldata.fwhm_ext.copy() - self.s_hat = np.concatenate((self.s_hat, self.external_maps), axis=0) - self.s_hat_noise = np.concatenate( - (self.s_hat_noise, self.external_maps_noise), axis=0 - ) - self.nus_rec = np.array( - list(self.nus_Q) + list(self.externaldata.external_nus) - ) - self.fwhm_rec = np.array(list(self.fwhm_rec) + list(fwhm_ext)) - - self.plots.plot_frequency_maps( - self.m_nu_in[: len(self.nus_Q)], - self.s_hat[: len(self.nus_Q)], - self.center, - reso=15, - nsig=3, - filename=self.plot_folder + f"/all_maps.png", - figsize=(10, 5), - ) - # self.plots.plot_FMM(self.m_nu_in, self.s_hat, self.center, self.seenpix, self.nus_Q, job_id=self.job_id, istk=0, nsig=3, name='signal') - # self.plots.plot_FMM(self.m_nu_in, self.s_hat, self.center, self.seenpix, self.nus_Q, job_id=self.job_id, istk=1, nsig=3, name='signal') - # self.plots.plot_FMM(self.m_nu_in, self.s_hat, self.center, self.seenpix, self.nus_Q, job_id=self.job_id, istk=2, nsig=3, name='signal') - - # self.plots.plot_FMM(self.m_nu_in*0, self.s_hat_noise, self.center, self.seenpix, self.nus_Q, job_id=self.job_id, istk=0, nsig=3, name='noise') - # self.plots.plot_FMM(self.m_nu_in*0, self.s_hat_noise, self.center, self.seenpix, self.nus_Q, job_id=self.job_id, istk=1, nsig=3, name='noise') - # self.plots.plot_FMM(self.m_nu_in*0, self.s_hat_noise, self.center, self.seenpix, self.nus_Q, job_id=self.job_id, istk=2, nsig=3, name='noise') - - mapmaking_time = time.time() - self.mapmaking_time_0 - if self.comm is None: - print(f"Map-making done in {mapmaking_time:.3f} s") - else: - if self.rank == 0: - print(f"Map-making done in {mapmaking_time:.3f} s") - - dict_solution = { - "maps": self.s_hat, - "maps_noise": self.s_hat_noise, - "nus": self.nus_rec, - "coverage": self.coverage, - "center": self.center, - "maps_in": self.m_nu_in, - "parameters": self.params, - "fwhm_in": self.fwhm_in, - "fwhm_out": self.fwhm_out, - "fwhm_rec": self.fwhm_rec, - "duration": mapmaking_time, - } - - self._save_data(self.file, dict_solution) - self._barrier()
-
- - - -
-[docs] -class PipelineEnd2End: - """FMM Pipeline. - - Wrapper for End-2-End pipeline. It added class one after the others by running method.run(). - - """ - - def __init__(self, comm): - - with open("src/FMM/params.yml", "r") as stream: - self.params = yaml.safe_load(stream) - - self.comm = comm - self.job_id = os.environ.get("SLURM_JOB_ID") - - self.folder = "src/FMM/" + self.params["path_out"] + "maps/" - self.file = self.folder + self.params["datafilename"] + f"_{self.job_id}.pkl" - self.file_spectrum = ( - "src/FMM/" - + self.params["path_out"] - + "spectrum/" - + "spectrum_" - + self.params["datafilename"] - + f"_{self.job_id}.pkl" - ) - self.mapmaking = None - -
-[docs] - def main(self, specific_file=None): - - ### Execute Frequency Map-Making - if self.params["Pipeline"]["mapmaking"]: - - ### Initialization - self.mapmaking = PipelineFrequencyMapMaking( - self.comm, self.file, self.params - ) - - ### Run - self.mapmaking.run() - - ### Execute spectrum - if self.params["Pipeline"]["spectrum"]: - if self.comm.Get_rank() == 0: - create_folder_if_not_exists( - self.comm, "src/FMM/" + self.params["path_out"] + "spectrum/" - ) - - if self.mapmaking is not None: - self.spectrum = Spectra(self.file) - else: - self.spectrum = Spectra(specific_file) - - ### Signal - DlBB_maps = self.spectrum.run(maps=self.spectrum.maps) - - ### noise - DlBB_noise = self.spectrum.run( - maps=self.spectrum.dictionary["maps_noise"] - ) - - dict_solution = { - "nus": self.spectrum.dictionary["nus"], - "ell": self.spectrum.ell, - "Dls": DlBB_maps, - "Nl": DlBB_noise, - "parameters": self.params, - } - - self._save_data(self.file_spectrum, dict_solution)
-
- -
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/index.html b/docs/_build/html/_modules/index.html deleted file mode 100644 index 6c9833b..0000000 --- a/docs/_build/html/_modules/index.html +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - Overview: module code — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
  • - -
  • -
  • -
-
-
- - -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_sources/CMM.pipeline.rst.txt b/docs/_build/html/_sources/CMM.pipeline.rst.txt deleted file mode 100644 index b5f6c23..0000000 --- a/docs/_build/html/_sources/CMM.pipeline.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -CMM.pipeline module -=================== - -.. automodule:: CMM.pipeline - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_build/html/_sources/CMM.preset.preset_.rst.txt b/docs/_build/html/_sources/CMM.preset.preset_.rst.txt deleted file mode 100644 index 7bfe725..0000000 --- a/docs/_build/html/_sources/CMM.preset.preset_.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -CMM.preset.preset\_ module -========================== - -.. automodule:: CMM.preset.preset_ - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_build/html/_sources/CMM.preset.preset_acquisition.rst.txt b/docs/_build/html/_sources/CMM.preset.preset_acquisition.rst.txt deleted file mode 100644 index acef6ee..0000000 --- a/docs/_build/html/_sources/CMM.preset.preset_acquisition.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -CMM.preset.preset\_acquisition module -===================================== - -.. automodule:: CMM.preset.preset_acquisition - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_build/html/_sources/CMM.preset.preset_components.rst.txt b/docs/_build/html/_sources/CMM.preset.preset_components.rst.txt deleted file mode 100644 index aad9f00..0000000 --- a/docs/_build/html/_sources/CMM.preset.preset_components.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -CMM.preset.preset\_components module -==================================== - -.. automodule:: CMM.preset.preset_components - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_build/html/_sources/CMM.preset.preset_external_data.rst.txt b/docs/_build/html/_sources/CMM.preset.preset_external_data.rst.txt deleted file mode 100644 index d03f709..0000000 --- a/docs/_build/html/_sources/CMM.preset.preset_external_data.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -CMM.preset.preset\_external\_data module -======================================== - -.. automodule:: CMM.preset.preset_external_data - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_build/html/_sources/CMM.preset.preset_gain.rst.txt b/docs/_build/html/_sources/CMM.preset.preset_gain.rst.txt deleted file mode 100644 index c72878f..0000000 --- a/docs/_build/html/_sources/CMM.preset.preset_gain.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -CMM.preset.preset\_gain module -============================== - -.. automodule:: CMM.preset.preset_gain - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_build/html/_sources/CMM.preset.preset_mixingmatrix.rst.txt b/docs/_build/html/_sources/CMM.preset.preset_mixingmatrix.rst.txt deleted file mode 100644 index 4a61e45..0000000 --- a/docs/_build/html/_sources/CMM.preset.preset_mixingmatrix.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -CMM.preset.preset\_mixingmatrix module -====================================== - -.. automodule:: CMM.preset.preset_mixingmatrix - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_build/html/_sources/CMM.preset.preset_qubic.rst.txt b/docs/_build/html/_sources/CMM.preset.preset_qubic.rst.txt deleted file mode 100644 index d6438b2..0000000 --- a/docs/_build/html/_sources/CMM.preset.preset_qubic.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -CMM.preset.preset\_qubic module -=============================== - -.. automodule:: CMM.preset.preset_qubic - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_build/html/_sources/CMM.preset.preset_sky.rst.txt b/docs/_build/html/_sources/CMM.preset.preset_sky.rst.txt deleted file mode 100644 index ec81404..0000000 --- a/docs/_build/html/_sources/CMM.preset.preset_sky.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -CMM.preset.preset\_sky module -============================= - -.. automodule:: CMM.preset.preset_sky - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_build/html/_sources/CMM.preset.preset_tools.rst.txt b/docs/_build/html/_sources/CMM.preset.preset_tools.rst.txt deleted file mode 100644 index 7d2a7f5..0000000 --- a/docs/_build/html/_sources/CMM.preset.preset_tools.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -CMM.preset.preset\_tools module -=============================== - -.. automodule:: CMM.preset.preset_tools - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_build/html/_sources/CMM.preset.rst.txt b/docs/_build/html/_sources/CMM.preset.rst.txt deleted file mode 100644 index ea75d5a..0000000 --- a/docs/_build/html/_sources/CMM.preset.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -CMM.preset package -================== - -.. automodule:: CMM.preset - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - CMM.preset.preset_ - CMM.preset.preset_acquisition - CMM.preset.preset_components - CMM.preset.preset_external_data - CMM.preset.preset_gain - CMM.preset.preset_mixingmatrix - CMM.preset.preset_qubic - CMM.preset.preset_sky - CMM.preset.preset_tools diff --git a/docs/_build/html/_sources/CMM.rst.txt b/docs/_build/html/_sources/CMM.rst.txt deleted file mode 100644 index fbc37a3..0000000 --- a/docs/_build/html/_sources/CMM.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -CMM package -=========== - -.. automodule:: CMM - :members: - :undoc-members: - :show-inheritance: - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - CMM.preset - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - CMM.pipeline diff --git a/docs/_build/html/_sources/FMM.main.rst.txt b/docs/_build/html/_sources/FMM.main.rst.txt deleted file mode 100644 index a1005ac..0000000 --- a/docs/_build/html/_sources/FMM.main.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -FMM.main module -=============== - -.. automodule:: FMM.main - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_build/html/_sources/FMM.pipeline.rst.txt b/docs/_build/html/_sources/FMM.pipeline.rst.txt deleted file mode 100644 index 1d32d07..0000000 --- a/docs/_build/html/_sources/FMM.pipeline.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -FMM.pipeline module -=================== - -.. automodule:: FMM.pipeline - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_build/html/_sources/FMM.rst.txt b/docs/_build/html/_sources/FMM.rst.txt deleted file mode 100644 index becfcca..0000000 --- a/docs/_build/html/_sources/FMM.rst.txt +++ /dev/null @@ -1,16 +0,0 @@ -FMM package -=========== - -.. automodule:: FMM - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - FMM.main - FMM.pipeline diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt deleted file mode 100644 index 0796419..0000000 --- a/docs/_build/html/_sources/index.rst.txt +++ /dev/null @@ -1,14 +0,0 @@ -.. QUBIC Simulation Pipelines documentation master file, created by - sphinx-quickstart on Thu Sep 5 15:33:17 2024. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -QUBIC Simulation Pipelines documentation -======================================== - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - CMM - FMM \ No newline at end of file diff --git a/docs/_build/html/_sources/modules.rst.txt b/docs/_build/html/_sources/modules.rst.txt deleted file mode 100644 index 18a3901..0000000 --- a/docs/_build/html/_sources/modules.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -CMM -=== - -.. toctree:: - :maxdepth: 4 - - CMM diff --git a/docs/_build/html/_static/_sphinx_javascript_frameworks_compat.js b/docs/_build/html/_static/_sphinx_javascript_frameworks_compat.js deleted file mode 100644 index 8141580..0000000 --- a/docs/_build/html/_static/_sphinx_javascript_frameworks_compat.js +++ /dev/null @@ -1,123 +0,0 @@ -/* Compatability shim for jQuery and underscores.js. - * - * Copyright Sphinx contributors - * Released under the two clause BSD licence - */ - -/** - * small helper function to urldecode strings - * - * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL - */ -jQuery.urldecode = function(x) { - if (!x) { - return x - } - return decodeURIComponent(x.replace(/\+/g, ' ')); -}; - -/** - * small helper function to urlencode strings - */ -jQuery.urlencode = encodeURIComponent; - -/** - * This function returns the parsed url parameters of the - * current request. Multiple values per key are supported, - * it will always return arrays of strings for the value parts. - */ -jQuery.getQueryParameters = function(s) { - if (typeof s === 'undefined') - s = document.location.search; - var parts = s.substr(s.indexOf('?') + 1).split('&'); - var result = {}; - for (var i = 0; i < parts.length; i++) { - var tmp = parts[i].split('=', 2); - var key = jQuery.urldecode(tmp[0]); - var value = jQuery.urldecode(tmp[1]); - if (key in result) - result[key].push(value); - else - result[key] = [value]; - } - return result; -}; - -/** - * highlight a given string on a jquery object by wrapping it in - * span elements with the given class name. - */ -jQuery.fn.highlightText = function(text, className) { - function highlight(node, addItems) { - if (node.nodeType === 3) { - var val = node.nodeValue; - var pos = val.toLowerCase().indexOf(text); - if (pos >= 0 && - !jQuery(node.parentNode).hasClass(className) && - !jQuery(node.parentNode).hasClass("nohighlight")) { - var span; - var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); - if (isInSVG) { - span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); - } else { - span = document.createElement("span"); - span.className = className; - } - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - node.parentNode.insertBefore(span, node.parentNode.insertBefore( - document.createTextNode(val.substr(pos + text.length)), - node.nextSibling)); - node.nodeValue = val.substr(0, pos); - if (isInSVG) { - var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); - var bbox = node.parentElement.getBBox(); - rect.x.baseVal.value = bbox.x; - rect.y.baseVal.value = bbox.y; - rect.width.baseVal.value = bbox.width; - rect.height.baseVal.value = bbox.height; - rect.setAttribute('class', className); - addItems.push({ - "parent": node.parentNode, - "target": rect}); - } - } - } - else if (!jQuery(node).is("button, select, textarea")) { - jQuery.each(node.childNodes, function() { - highlight(this, addItems); - }); - } - } - var addItems = []; - var result = this.each(function() { - highlight(this, addItems); - }); - for (var i = 0; i < addItems.length; ++i) { - jQuery(addItems[i].parent).before(addItems[i].target); - } - return result; -}; - -/* - * backward compatibility for jQuery.browser - * This will be supported until firefox bug is fixed. - */ -if (!jQuery.browser) { - jQuery.uaMatch = function(ua) { - ua = ua.toLowerCase(); - - var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || - /(webkit)[ \/]([\w.]+)/.exec(ua) || - /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || - /(msie) ([\w.]+)/.exec(ua) || - ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || - []; - - return { - browser: match[ 1 ] || "", - version: match[ 2 ] || "0" - }; - }; - jQuery.browser = {}; - jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; -} diff --git a/docs/_build/html/_static/basic.css b/docs/_build/html/_static/basic.css deleted file mode 100644 index f316efc..0000000 --- a/docs/_build/html/_static/basic.css +++ /dev/null @@ -1,925 +0,0 @@ -/* - * basic.css - * ~~~~~~~~~ - * - * Sphinx stylesheet -- basic theme. - * - * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/* -- main layout ----------------------------------------------------------- */ - -div.clearer { - clear: both; -} - -div.section::after { - display: block; - content: ''; - clear: left; -} - -/* -- relbar ---------------------------------------------------------------- */ - -div.related { - width: 100%; - font-size: 90%; -} - -div.related h3 { - display: none; -} - -div.related ul { - margin: 0; - padding: 0 0 0 10px; - list-style: none; -} - -div.related li { - display: inline; -} - -div.related li.right { - float: right; - margin-right: 5px; -} - -/* -- sidebar --------------------------------------------------------------- */ - -div.sphinxsidebarwrapper { - padding: 10px 5px 0 10px; -} - -div.sphinxsidebar { - float: left; - width: 230px; - margin-left: -100%; - font-size: 90%; - word-wrap: break-word; - overflow-wrap : break-word; -} - -div.sphinxsidebar ul { - list-style: none; -} - -div.sphinxsidebar ul ul, -div.sphinxsidebar ul.want-points { - margin-left: 20px; - list-style: square; -} - -div.sphinxsidebar ul ul { - margin-top: 0; - margin-bottom: 0; -} - -div.sphinxsidebar form { - margin-top: 10px; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - -div.sphinxsidebar #searchbox form.search { - overflow: hidden; -} - -div.sphinxsidebar #searchbox input[type="text"] { - float: left; - width: 80%; - padding: 0.25em; - box-sizing: border-box; -} - -div.sphinxsidebar #searchbox input[type="submit"] { - float: left; - width: 20%; - border-left: none; - padding: 0.25em; - box-sizing: border-box; -} - - -img { - border: 0; - max-width: 100%; -} - -/* -- search page ----------------------------------------------------------- */ - -ul.search { - margin: 10px 0 0 20px; - padding: 0; -} - -ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; -} - -ul.search li a { - font-weight: bold; -} - -ul.search li p.context { - color: #888; - margin: 2px 0 0 30px; - text-align: left; -} - -ul.keywordmatches li.goodmatch a { - font-weight: bold; -} - -/* -- index page ------------------------------------------------------------ */ - -table.contentstable { - width: 90%; - margin-left: auto; - margin-right: auto; -} - -table.contentstable p.biglink { - line-height: 150%; -} - -a.biglink { - font-size: 1.3em; -} - -span.linkdescr { - font-style: italic; - padding-top: 5px; - font-size: 90%; -} - -/* -- general index --------------------------------------------------------- */ - -table.indextable { - width: 100%; -} - -table.indextable td { - text-align: left; - vertical-align: top; -} - -table.indextable ul { - margin-top: 0; - margin-bottom: 0; - list-style-type: none; -} - -table.indextable > tbody > tr > td > ul { - padding-left: 0em; -} - -table.indextable tr.pcap { - height: 10px; -} - -table.indextable tr.cap { - margin-top: 10px; - background-color: #f2f2f2; -} - -img.toggler { - margin-right: 3px; - margin-top: 3px; - cursor: pointer; -} - -div.modindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -div.genindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -/* -- domain module index --------------------------------------------------- */ - -table.modindextable td { - padding: 2px; - border-collapse: collapse; -} - -/* -- general body styles --------------------------------------------------- */ - -div.body { - min-width: 360px; - max-width: 800px; -} - -div.body p, div.body dd, div.body li, div.body blockquote { - -moz-hyphens: auto; - -ms-hyphens: auto; - -webkit-hyphens: auto; - hyphens: auto; -} - -a.headerlink { - visibility: hidden; -} - -a:visited { - color: #551A8B; -} - -h1:hover > a.headerlink, -h2:hover > a.headerlink, -h3:hover > a.headerlink, -h4:hover > a.headerlink, -h5:hover > a.headerlink, -h6:hover > a.headerlink, -dt:hover > a.headerlink, -caption:hover > a.headerlink, -p.caption:hover > a.headerlink, -div.code-block-caption:hover > a.headerlink { - visibility: visible; -} - -div.body p.caption { - text-align: inherit; -} - -div.body td { - text-align: left; -} - -.first { - margin-top: 0 !important; -} - -p.rubric { - margin-top: 30px; - font-weight: bold; -} - -img.align-left, figure.align-left, .figure.align-left, object.align-left { - clear: left; - float: left; - margin-right: 1em; -} - -img.align-right, figure.align-right, .figure.align-right, object.align-right { - clear: right; - float: right; - margin-left: 1em; -} - -img.align-center, figure.align-center, .figure.align-center, object.align-center { - display: block; - margin-left: auto; - margin-right: auto; -} - -img.align-default, figure.align-default, .figure.align-default { - display: block; - margin-left: auto; - margin-right: auto; -} - -.align-left { - text-align: left; -} - -.align-center { - text-align: center; -} - -.align-default { - text-align: center; -} - -.align-right { - text-align: right; -} - -/* -- sidebars -------------------------------------------------------------- */ - -div.sidebar, -aside.sidebar { - margin: 0 0 0.5em 1em; - border: 1px solid #ddb; - padding: 7px; - background-color: #ffe; - width: 40%; - float: right; - clear: right; - overflow-x: auto; -} - -p.sidebar-title { - font-weight: bold; -} - -nav.contents, -aside.topic, -div.admonition, div.topic, blockquote { - clear: left; -} - -/* -- topics ---------------------------------------------------------------- */ - -nav.contents, -aside.topic, -div.topic { - border: 1px solid #ccc; - padding: 7px; - margin: 10px 0 10px 0; -} - -p.topic-title { - font-size: 1.1em; - font-weight: bold; - margin-top: 10px; -} - -/* -- admonitions ----------------------------------------------------------- */ - -div.admonition { - margin-top: 10px; - margin-bottom: 10px; - padding: 7px; -} - -div.admonition dt { - font-weight: bold; -} - -p.admonition-title { - margin: 0px 10px 5px 0px; - font-weight: bold; -} - -div.body p.centered { - text-align: center; - margin-top: 25px; -} - -/* -- content of sidebars/topics/admonitions -------------------------------- */ - -div.sidebar > :last-child, -aside.sidebar > :last-child, -nav.contents > :last-child, -aside.topic > :last-child, -div.topic > :last-child, -div.admonition > :last-child { - margin-bottom: 0; -} - -div.sidebar::after, -aside.sidebar::after, -nav.contents::after, -aside.topic::after, -div.topic::after, -div.admonition::after, -blockquote::after { - display: block; - content: ''; - clear: both; -} - -/* -- tables ---------------------------------------------------------------- */ - -table.docutils { - margin-top: 10px; - margin-bottom: 10px; - border: 0; - border-collapse: collapse; -} - -table.align-center { - margin-left: auto; - margin-right: auto; -} - -table.align-default { - margin-left: auto; - margin-right: auto; -} - -table caption span.caption-number { - font-style: italic; -} - -table caption span.caption-text { -} - -table.docutils td, table.docutils th { - padding: 1px 8px 1px 5px; - border-top: 0; - border-left: 0; - border-right: 0; - border-bottom: 1px solid #aaa; -} - -th { - text-align: left; - padding-right: 5px; -} - -table.citation { - border-left: solid 1px gray; - margin-left: 1px; -} - -table.citation td { - border-bottom: none; -} - -th > :first-child, -td > :first-child { - margin-top: 0px; -} - -th > :last-child, -td > :last-child { - margin-bottom: 0px; -} - -/* -- figures --------------------------------------------------------------- */ - -div.figure, figure { - margin: 0.5em; - padding: 0.5em; -} - -div.figure p.caption, figcaption { - padding: 0.3em; -} - -div.figure p.caption span.caption-number, -figcaption span.caption-number { - font-style: italic; -} - -div.figure p.caption span.caption-text, -figcaption span.caption-text { -} - -/* -- field list styles ----------------------------------------------------- */ - -table.field-list td, table.field-list th { - border: 0 !important; -} - -.field-list ul { - margin: 0; - padding-left: 1em; -} - -.field-list p { - margin: 0; -} - -.field-name { - -moz-hyphens: manual; - -ms-hyphens: manual; - -webkit-hyphens: manual; - hyphens: manual; -} - -/* -- hlist styles ---------------------------------------------------------- */ - -table.hlist { - margin: 1em 0; -} - -table.hlist td { - vertical-align: top; -} - -/* -- object description styles --------------------------------------------- */ - -.sig { - font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; -} - -.sig-name, code.descname { - background-color: transparent; - font-weight: bold; -} - -.sig-name { - font-size: 1.1em; -} - -code.descname { - font-size: 1.2em; -} - -.sig-prename, code.descclassname { - background-color: transparent; -} - -.optional { - font-size: 1.3em; -} - -.sig-paren { - font-size: larger; -} - -.sig-param.n { - font-style: italic; -} - -/* C++ specific styling */ - -.sig-inline.c-texpr, -.sig-inline.cpp-texpr { - font-family: unset; -} - -.sig.c .k, .sig.c .kt, -.sig.cpp .k, .sig.cpp .kt { - color: #0033B3; -} - -.sig.c .m, -.sig.cpp .m { - color: #1750EB; -} - -.sig.c .s, .sig.c .sc, -.sig.cpp .s, .sig.cpp .sc { - color: #067D17; -} - - -/* -- other body styles ----------------------------------------------------- */ - -ol.arabic { - list-style: decimal; -} - -ol.loweralpha { - list-style: lower-alpha; -} - -ol.upperalpha { - list-style: upper-alpha; -} - -ol.lowerroman { - list-style: lower-roman; -} - -ol.upperroman { - list-style: upper-roman; -} - -:not(li) > ol > li:first-child > :first-child, -:not(li) > ul > li:first-child > :first-child { - margin-top: 0px; -} - -:not(li) > ol > li:last-child > :last-child, -:not(li) > ul > li:last-child > :last-child { - margin-bottom: 0px; -} - -ol.simple ol p, -ol.simple ul p, -ul.simple ol p, -ul.simple ul p { - margin-top: 0; -} - -ol.simple > li:not(:first-child) > p, -ul.simple > li:not(:first-child) > p { - margin-top: 0; -} - -ol.simple p, -ul.simple p { - margin-bottom: 0; -} - -aside.footnote > span, -div.citation > span { - float: left; -} -aside.footnote > span:last-of-type, -div.citation > span:last-of-type { - padding-right: 0.5em; -} -aside.footnote > p { - margin-left: 2em; -} -div.citation > p { - margin-left: 4em; -} -aside.footnote > p:last-of-type, -div.citation > p:last-of-type { - margin-bottom: 0em; -} -aside.footnote > p:last-of-type:after, -div.citation > p:last-of-type:after { - content: ""; - clear: both; -} - -dl.field-list { - display: grid; - grid-template-columns: fit-content(30%) auto; -} - -dl.field-list > dt { - font-weight: bold; - word-break: break-word; - padding-left: 0.5em; - padding-right: 5px; -} - -dl.field-list > dd { - padding-left: 0.5em; - margin-top: 0em; - margin-left: 0em; - margin-bottom: 0em; -} - -dl { - margin-bottom: 15px; -} - -dd > :first-child { - margin-top: 0px; -} - -dd ul, dd table { - margin-bottom: 10px; -} - -dd { - margin-top: 3px; - margin-bottom: 10px; - margin-left: 30px; -} - -.sig dd { - margin-top: 0px; - margin-bottom: 0px; -} - -.sig dl { - margin-top: 0px; - margin-bottom: 0px; -} - -dl > dd:last-child, -dl > dd:last-child > :last-child { - margin-bottom: 0; -} - -dt:target, span.highlighted { - background-color: #fbe54e; -} - -rect.highlighted { - fill: #fbe54e; -} - -dl.glossary dt { - font-weight: bold; - font-size: 1.1em; -} - -.versionmodified { - font-style: italic; -} - -.system-message { - background-color: #fda; - padding: 5px; - border: 3px solid red; -} - -.footnote:target { - background-color: #ffa; -} - -.line-block { - display: block; - margin-top: 1em; - margin-bottom: 1em; -} - -.line-block .line-block { - margin-top: 0; - margin-bottom: 0; - margin-left: 1.5em; -} - -.guilabel, .menuselection { - font-family: sans-serif; -} - -.accelerator { - text-decoration: underline; -} - -.classifier { - font-style: oblique; -} - -.classifier:before { - font-style: normal; - margin: 0 0.5em; - content: ":"; - display: inline-block; -} - -abbr, acronym { - border-bottom: dotted 1px; - cursor: help; -} - -.translated { - background-color: rgba(207, 255, 207, 0.2) -} - -.untranslated { - background-color: rgba(255, 207, 207, 0.2) -} - -/* -- code displays --------------------------------------------------------- */ - -pre { - overflow: auto; - overflow-y: hidden; /* fixes display issues on Chrome browsers */ -} - -pre, div[class*="highlight-"] { - clear: both; -} - -span.pre { - -moz-hyphens: none; - -ms-hyphens: none; - -webkit-hyphens: none; - hyphens: none; - white-space: nowrap; -} - -div[class*="highlight-"] { - margin: 1em 0; -} - -td.linenos pre { - border: 0; - background-color: transparent; - color: #aaa; -} - -table.highlighttable { - display: block; -} - -table.highlighttable tbody { - display: block; -} - -table.highlighttable tr { - display: flex; -} - -table.highlighttable td { - margin: 0; - padding: 0; -} - -table.highlighttable td.linenos { - padding-right: 0.5em; -} - -table.highlighttable td.code { - flex: 1; - overflow: hidden; -} - -.highlight .hll { - display: block; -} - -div.highlight pre, -table.highlighttable pre { - margin: 0; -} - -div.code-block-caption + div { - margin-top: 0; -} - -div.code-block-caption { - margin-top: 1em; - padding: 2px 5px; - font-size: small; -} - -div.code-block-caption code { - background-color: transparent; -} - -table.highlighttable td.linenos, -span.linenos, -div.highlight span.gp { /* gp: Generic.Prompt */ - user-select: none; - -webkit-user-select: text; /* Safari fallback only */ - -webkit-user-select: none; /* Chrome/Safari */ - -moz-user-select: none; /* Firefox */ - -ms-user-select: none; /* IE10+ */ -} - -div.code-block-caption span.caption-number { - padding: 0.1em 0.3em; - font-style: italic; -} - -div.code-block-caption span.caption-text { -} - -div.literal-block-wrapper { - margin: 1em 0; -} - -code.xref, a code { - background-color: transparent; - font-weight: bold; -} - -h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { - background-color: transparent; -} - -.viewcode-link { - float: right; -} - -.viewcode-back { - float: right; - font-family: sans-serif; -} - -div.viewcode-block:target { - margin: -1px -10px; - padding: 0 10px; -} - -/* -- math display ---------------------------------------------------------- */ - -img.math { - vertical-align: middle; -} - -div.body div.math p { - text-align: center; -} - -span.eqno { - float: right; -} - -span.eqno a.headerlink { - position: absolute; - z-index: 1; -} - -div.math:hover a.headerlink { - visibility: visible; -} - -/* -- printout stylesheet --------------------------------------------------- */ - -@media print { - div.document, - div.documentwrapper, - div.bodywrapper { - margin: 0 !important; - width: 100%; - } - - div.sphinxsidebar, - div.related, - div.footer, - #top-link { - display: none; - } -} \ No newline at end of file diff --git a/docs/_build/html/_static/css/badge_only.css b/docs/_build/html/_static/css/badge_only.css deleted file mode 100644 index c718cee..0000000 --- a/docs/_build/html/_static/css/badge_only.css +++ /dev/null @@ -1 +0,0 @@ -.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/docs/_build/html/_static/css/fonts/Roboto-Slab-Bold.woff b/docs/_build/html/_static/css/fonts/Roboto-Slab-Bold.woff deleted file mode 100644 index 6cb6000..0000000 Binary files a/docs/_build/html/_static/css/fonts/Roboto-Slab-Bold.woff and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 b/docs/_build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 deleted file mode 100644 index 7059e23..0000000 Binary files a/docs/_build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/Roboto-Slab-Regular.woff b/docs/_build/html/_static/css/fonts/Roboto-Slab-Regular.woff deleted file mode 100644 index f815f63..0000000 Binary files a/docs/_build/html/_static/css/fonts/Roboto-Slab-Regular.woff and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 b/docs/_build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 deleted file mode 100644 index f2c76e5..0000000 Binary files a/docs/_build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/fontawesome-webfont.eot b/docs/_build/html/_static/css/fonts/fontawesome-webfont.eot deleted file mode 100644 index e9f60ca..0000000 Binary files a/docs/_build/html/_static/css/fonts/fontawesome-webfont.eot and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/fontawesome-webfont.svg b/docs/_build/html/_static/css/fonts/fontawesome-webfont.svg deleted file mode 100644 index 855c845..0000000 --- a/docs/_build/html/_static/css/fonts/fontawesome-webfont.svg +++ /dev/null @@ -1,2671 +0,0 @@ - - - - -Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 - By ,,, -Copyright Dave Gandy 2016. All rights reserved. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/_build/html/_static/css/fonts/fontawesome-webfont.ttf b/docs/_build/html/_static/css/fonts/fontawesome-webfont.ttf deleted file mode 100644 index 35acda2..0000000 Binary files a/docs/_build/html/_static/css/fonts/fontawesome-webfont.ttf and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/fontawesome-webfont.woff b/docs/_build/html/_static/css/fonts/fontawesome-webfont.woff deleted file mode 100644 index 400014a..0000000 Binary files a/docs/_build/html/_static/css/fonts/fontawesome-webfont.woff and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/fontawesome-webfont.woff2 b/docs/_build/html/_static/css/fonts/fontawesome-webfont.woff2 deleted file mode 100644 index 4d13fc6..0000000 Binary files a/docs/_build/html/_static/css/fonts/fontawesome-webfont.woff2 and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/lato-bold-italic.woff b/docs/_build/html/_static/css/fonts/lato-bold-italic.woff deleted file mode 100644 index 88ad05b..0000000 Binary files a/docs/_build/html/_static/css/fonts/lato-bold-italic.woff and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/lato-bold-italic.woff2 b/docs/_build/html/_static/css/fonts/lato-bold-italic.woff2 deleted file mode 100644 index c4e3d80..0000000 Binary files a/docs/_build/html/_static/css/fonts/lato-bold-italic.woff2 and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/lato-bold.woff b/docs/_build/html/_static/css/fonts/lato-bold.woff deleted file mode 100644 index c6dff51..0000000 Binary files a/docs/_build/html/_static/css/fonts/lato-bold.woff and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/lato-bold.woff2 b/docs/_build/html/_static/css/fonts/lato-bold.woff2 deleted file mode 100644 index bb19504..0000000 Binary files a/docs/_build/html/_static/css/fonts/lato-bold.woff2 and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/lato-normal-italic.woff b/docs/_build/html/_static/css/fonts/lato-normal-italic.woff deleted file mode 100644 index 76114bc..0000000 Binary files a/docs/_build/html/_static/css/fonts/lato-normal-italic.woff and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/lato-normal-italic.woff2 b/docs/_build/html/_static/css/fonts/lato-normal-italic.woff2 deleted file mode 100644 index 3404f37..0000000 Binary files a/docs/_build/html/_static/css/fonts/lato-normal-italic.woff2 and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/lato-normal.woff b/docs/_build/html/_static/css/fonts/lato-normal.woff deleted file mode 100644 index ae1307f..0000000 Binary files a/docs/_build/html/_static/css/fonts/lato-normal.woff and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/lato-normal.woff2 b/docs/_build/html/_static/css/fonts/lato-normal.woff2 deleted file mode 100644 index 3bf9843..0000000 Binary files a/docs/_build/html/_static/css/fonts/lato-normal.woff2 and /dev/null differ diff --git a/docs/_build/html/_static/css/theme.css b/docs/_build/html/_static/css/theme.css deleted file mode 100644 index 19a446a..0000000 --- a/docs/_build/html/_static/css/theme.css +++ /dev/null @@ -1,4 +0,0 @@ -html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! - * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome - * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) - */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/docs/_build/html/_static/doctools.js b/docs/_build/html/_static/doctools.js deleted file mode 100644 index 4d67807..0000000 --- a/docs/_build/html/_static/doctools.js +++ /dev/null @@ -1,156 +0,0 @@ -/* - * doctools.js - * ~~~~~~~~~~~ - * - * Base JavaScript utilities for all Sphinx HTML documentation. - * - * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ -"use strict"; - -const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ - "TEXTAREA", - "INPUT", - "SELECT", - "BUTTON", -]); - -const _ready = (callback) => { - if (document.readyState !== "loading") { - callback(); - } else { - document.addEventListener("DOMContentLoaded", callback); - } -}; - -/** - * Small JavaScript module for the documentation. - */ -const Documentation = { - init: () => { - Documentation.initDomainIndexTable(); - Documentation.initOnKeyListeners(); - }, - - /** - * i18n support - */ - TRANSLATIONS: {}, - PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), - LOCALE: "unknown", - - // gettext and ngettext don't access this so that the functions - // can safely bound to a different name (_ = Documentation.gettext) - gettext: (string) => { - const translated = Documentation.TRANSLATIONS[string]; - switch (typeof translated) { - case "undefined": - return string; // no translation - case "string": - return translated; // translation exists - default: - return translated[0]; // (singular, plural) translation tuple exists - } - }, - - ngettext: (singular, plural, n) => { - const translated = Documentation.TRANSLATIONS[singular]; - if (typeof translated !== "undefined") - return translated[Documentation.PLURAL_EXPR(n)]; - return n === 1 ? singular : plural; - }, - - addTranslations: (catalog) => { - Object.assign(Documentation.TRANSLATIONS, catalog.messages); - Documentation.PLURAL_EXPR = new Function( - "n", - `return (${catalog.plural_expr})` - ); - Documentation.LOCALE = catalog.locale; - }, - - /** - * helper function to focus on search bar - */ - focusSearchBar: () => { - document.querySelectorAll("input[name=q]")[0]?.focus(); - }, - - /** - * Initialise the domain index toggle buttons - */ - initDomainIndexTable: () => { - const toggler = (el) => { - const idNumber = el.id.substr(7); - const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); - if (el.src.substr(-9) === "minus.png") { - el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; - toggledRows.forEach((el) => (el.style.display = "none")); - } else { - el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; - toggledRows.forEach((el) => (el.style.display = "")); - } - }; - - const togglerElements = document.querySelectorAll("img.toggler"); - togglerElements.forEach((el) => - el.addEventListener("click", (event) => toggler(event.currentTarget)) - ); - togglerElements.forEach((el) => (el.style.display = "")); - if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); - }, - - initOnKeyListeners: () => { - // only install a listener if it is really needed - if ( - !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && - !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS - ) - return; - - document.addEventListener("keydown", (event) => { - // bail for input elements - if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; - // bail with special keys - if (event.altKey || event.ctrlKey || event.metaKey) return; - - if (!event.shiftKey) { - switch (event.key) { - case "ArrowLeft": - if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; - - const prevLink = document.querySelector('link[rel="prev"]'); - if (prevLink && prevLink.href) { - window.location.href = prevLink.href; - event.preventDefault(); - } - break; - case "ArrowRight": - if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; - - const nextLink = document.querySelector('link[rel="next"]'); - if (nextLink && nextLink.href) { - window.location.href = nextLink.href; - event.preventDefault(); - } - break; - } - } - - // some keyboard layouts may need Shift to get / - switch (event.key) { - case "/": - if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; - Documentation.focusSearchBar(); - event.preventDefault(); - } - }); - }, -}; - -// quick alias for translations -const _ = Documentation.gettext; - -_ready(Documentation.init); diff --git a/docs/_build/html/_static/documentation_options.js b/docs/_build/html/_static/documentation_options.js deleted file mode 100644 index 0cce2c7..0000000 --- a/docs/_build/html/_static/documentation_options.js +++ /dev/null @@ -1,13 +0,0 @@ -const DOCUMENTATION_OPTIONS = { - VERSION: '0.8', - LANGUAGE: 'en', - COLLAPSE_INDEX: false, - BUILDER: 'html', - FILE_SUFFIX: '.html', - LINK_SUFFIX: '.html', - HAS_SOURCE: true, - SOURCELINK_SUFFIX: '.txt', - NAVIGATION_WITH_KEYS: false, - SHOW_SEARCH_SUMMARY: true, - ENABLE_SEARCH_SHORTCUTS: true, -}; \ No newline at end of file diff --git a/docs/_build/html/_static/file.png b/docs/_build/html/_static/file.png deleted file mode 100644 index a858a41..0000000 Binary files a/docs/_build/html/_static/file.png and /dev/null differ diff --git a/docs/_build/html/_static/jquery.js b/docs/_build/html/_static/jquery.js deleted file mode 100644 index c4c6022..0000000 --- a/docs/_build/html/_static/jquery.js +++ /dev/null @@ -1,2 +0,0 @@ -/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ -!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/docs/_build/html/_static/js/html5shiv.min.js b/docs/_build/html/_static/js/html5shiv.min.js deleted file mode 100644 index cd1c674..0000000 --- a/docs/_build/html/_static/js/html5shiv.min.js +++ /dev/null @@ -1,4 +0,0 @@ -/** -* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed -*/ -!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/docs/_build/html/_static/js/theme.js b/docs/_build/html/_static/js/theme.js deleted file mode 100644 index 1fddb6e..0000000 --- a/docs/_build/html/_static/js/theme.js +++ /dev/null @@ -1 +0,0 @@ -!function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&"object"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:n}),2&e&&"string"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,"a",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p="",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e="undefined"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on("hashchange",t.reset),n&&t.win.on("scroll",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on("resize",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",(function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")})).on("click",".wy-menu-vertical .current ul li a",(function(){var t=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(t),e.hashChange()})).on("click","[data-toggle='rst-current-version']",(function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")})),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("
"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t0 - var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 - var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 - var s_v = "^(" + C + ")?" + v; // vowel in stem - - this.stemWord = function (w) { - var stem; - var suffix; - var firstch; - var origword = w; - - if (w.length < 3) - return w; - - var re; - var re2; - var re3; - var re4; - - firstch = w.substr(0,1); - if (firstch == "y") - w = firstch.toUpperCase() + w.substr(1); - - // Step 1a - re = /^(.+?)(ss|i)es$/; - re2 = /^(.+?)([^s])s$/; - - if (re.test(w)) - w = w.replace(re,"$1$2"); - else if (re2.test(w)) - w = w.replace(re2,"$1$2"); - - // Step 1b - re = /^(.+?)eed$/; - re2 = /^(.+?)(ed|ing)$/; - if (re.test(w)) { - var fp = re.exec(w); - re = new RegExp(mgr0); - if (re.test(fp[1])) { - re = /.$/; - w = w.replace(re,""); - } - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1]; - re2 = new RegExp(s_v); - if (re2.test(stem)) { - w = stem; - re2 = /(at|bl|iz)$/; - re3 = new RegExp("([^aeiouylsz])\\1$"); - re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re2.test(w)) - w = w + "e"; - else if (re3.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - else if (re4.test(w)) - w = w + "e"; - } - } - - // Step 1c - re = /^(.+?)y$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(s_v); - if (re.test(stem)) - w = stem + "i"; - } - - // Step 2 - re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step2list[suffix]; - } - - // Step 3 - re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step3list[suffix]; - } - - // Step 4 - re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; - re2 = /^(.+?)(s|t)(ion)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - if (re.test(stem)) - w = stem; - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1] + fp[2]; - re2 = new RegExp(mgr1); - if (re2.test(stem)) - w = stem; - } - - // Step 5 - re = /^(.+?)e$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - re2 = new RegExp(meq1); - re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) - w = stem; - } - re = /ll$/; - re2 = new RegExp(mgr1); - if (re.test(w) && re2.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - - // and turn initial Y back to y - if (firstch == "y") - w = firstch.toLowerCase() + w.substr(1); - return w; - } -} - diff --git a/docs/_build/html/_static/minus.png b/docs/_build/html/_static/minus.png deleted file mode 100644 index d96755f..0000000 Binary files a/docs/_build/html/_static/minus.png and /dev/null differ diff --git a/docs/_build/html/_static/plus.png b/docs/_build/html/_static/plus.png deleted file mode 100644 index 7107cec..0000000 Binary files a/docs/_build/html/_static/plus.png and /dev/null differ diff --git a/docs/_build/html/_static/pygments.css b/docs/_build/html/_static/pygments.css deleted file mode 100644 index 84ab303..0000000 --- a/docs/_build/html/_static/pygments.css +++ /dev/null @@ -1,75 +0,0 @@ -pre { line-height: 125%; } -td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } -span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } -td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -.highlight .hll { background-color: #ffffcc } -.highlight { background: #f8f8f8; } -.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */ -.highlight .err { border: 1px solid #FF0000 } /* Error */ -.highlight .k { color: #008000; font-weight: bold } /* Keyword */ -.highlight .o { color: #666666 } /* Operator */ -.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */ -.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */ -.highlight .cp { color: #9C6500 } /* Comment.Preproc */ -.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */ -.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */ -.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */ -.highlight .gd { color: #A00000 } /* Generic.Deleted */ -.highlight .ge { font-style: italic } /* Generic.Emph */ -.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -.highlight .gr { color: #E40000 } /* Generic.Error */ -.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ -.highlight .gi { color: #008400 } /* Generic.Inserted */ -.highlight .go { color: #717171 } /* Generic.Output */ -.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ -.highlight .gs { font-weight: bold } /* Generic.Strong */ -.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ -.highlight .gt { color: #0044DD } /* Generic.Traceback */ -.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ -.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ -.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ -.highlight .kp { color: #008000 } /* Keyword.Pseudo */ -.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ -.highlight .kt { color: #B00040 } /* Keyword.Type */ -.highlight .m { color: #666666 } /* Literal.Number */ -.highlight .s { color: #BA2121 } /* Literal.String */ -.highlight .na { color: #687822 } /* Name.Attribute */ -.highlight .nb { color: #008000 } /* Name.Builtin */ -.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ -.highlight .no { color: #880000 } /* Name.Constant */ -.highlight .nd { color: #AA22FF } /* Name.Decorator */ -.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */ -.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */ -.highlight .nf { color: #0000FF } /* Name.Function */ -.highlight .nl { color: #767600 } /* Name.Label */ -.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ -.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ -.highlight .nv { color: #19177C } /* Name.Variable */ -.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ -.highlight .w { color: #bbbbbb } /* Text.Whitespace */ -.highlight .mb { color: #666666 } /* Literal.Number.Bin */ -.highlight .mf { color: #666666 } /* Literal.Number.Float */ -.highlight .mh { color: #666666 } /* Literal.Number.Hex */ -.highlight .mi { color: #666666 } /* Literal.Number.Integer */ -.highlight .mo { color: #666666 } /* Literal.Number.Oct */ -.highlight .sa { color: #BA2121 } /* Literal.String.Affix */ -.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ -.highlight .sc { color: #BA2121 } /* Literal.String.Char */ -.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ -.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ -.highlight .s2 { color: #BA2121 } /* Literal.String.Double */ -.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */ -.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ -.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */ -.highlight .sx { color: #008000 } /* Literal.String.Other */ -.highlight .sr { color: #A45A77 } /* Literal.String.Regex */ -.highlight .s1 { color: #BA2121 } /* Literal.String.Single */ -.highlight .ss { color: #19177C } /* Literal.String.Symbol */ -.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ -.highlight .fm { color: #0000FF } /* Name.Function.Magic */ -.highlight .vc { color: #19177C } /* Name.Variable.Class */ -.highlight .vg { color: #19177C } /* Name.Variable.Global */ -.highlight .vi { color: #19177C } /* Name.Variable.Instance */ -.highlight .vm { color: #19177C } /* Name.Variable.Magic */ -.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/docs/_build/html/_static/searchtools.js b/docs/_build/html/_static/searchtools.js deleted file mode 100644 index b08d58c..0000000 --- a/docs/_build/html/_static/searchtools.js +++ /dev/null @@ -1,620 +0,0 @@ -/* - * searchtools.js - * ~~~~~~~~~~~~~~~~ - * - * Sphinx JavaScript utilities for the full-text search. - * - * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ -"use strict"; - -/** - * Simple result scoring code. - */ -if (typeof Scorer === "undefined") { - var Scorer = { - // Implement the following function to further tweak the score for each result - // The function takes a result array [docname, title, anchor, descr, score, filename] - // and returns the new score. - /* - score: result => { - const [docname, title, anchor, descr, score, filename] = result - return score - }, - */ - - // query matches the full name of an object - objNameMatch: 11, - // or matches in the last dotted part of the object name - objPartialMatch: 6, - // Additive scores depending on the priority of the object - objPrio: { - 0: 15, // used to be importantResults - 1: 5, // used to be objectResults - 2: -5, // used to be unimportantResults - }, - // Used when the priority is not in the mapping. - objPrioDefault: 0, - - // query found in title - title: 15, - partialTitle: 7, - // query found in terms - term: 5, - partialTerm: 2, - }; -} - -const _removeChildren = (element) => { - while (element && element.lastChild) element.removeChild(element.lastChild); -}; - -/** - * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping - */ -const _escapeRegExp = (string) => - string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string - -const _displayItem = (item, searchTerms, highlightTerms) => { - const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; - const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; - const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; - const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; - const contentRoot = document.documentElement.dataset.content_root; - - const [docName, title, anchor, descr, score, _filename] = item; - - let listItem = document.createElement("li"); - let requestUrl; - let linkUrl; - if (docBuilder === "dirhtml") { - // dirhtml builder - let dirname = docName + "/"; - if (dirname.match(/\/index\/$/)) - dirname = dirname.substring(0, dirname.length - 6); - else if (dirname === "index/") dirname = ""; - requestUrl = contentRoot + dirname; - linkUrl = requestUrl; - } else { - // normal html builders - requestUrl = contentRoot + docName + docFileSuffix; - linkUrl = docName + docLinkSuffix; - } - let linkEl = listItem.appendChild(document.createElement("a")); - linkEl.href = linkUrl + anchor; - linkEl.dataset.score = score; - linkEl.innerHTML = title; - if (descr) { - listItem.appendChild(document.createElement("span")).innerHTML = - " (" + descr + ")"; - // highlight search terms in the description - if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js - highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); - } - else if (showSearchSummary) - fetch(requestUrl) - .then((responseData) => responseData.text()) - .then((data) => { - if (data) - listItem.appendChild( - Search.makeSearchSummary(data, searchTerms, anchor) - ); - // highlight search terms in the summary - if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js - highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); - }); - Search.output.appendChild(listItem); -}; -const _finishSearch = (resultCount) => { - Search.stopPulse(); - Search.title.innerText = _("Search Results"); - if (!resultCount) - Search.status.innerText = Documentation.gettext( - "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." - ); - else - Search.status.innerText = _( - "Search finished, found ${resultCount} page(s) matching the search query." - ).replace('${resultCount}', resultCount); -}; -const _displayNextItem = ( - results, - resultCount, - searchTerms, - highlightTerms, -) => { - // results left, load the summary and display it - // this is intended to be dynamic (don't sub resultsCount) - if (results.length) { - _displayItem(results.pop(), searchTerms, highlightTerms); - setTimeout( - () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), - 5 - ); - } - // search finished, update title and status message - else _finishSearch(resultCount); -}; -// Helper function used by query() to order search results. -// Each input is an array of [docname, title, anchor, descr, score, filename]. -// Order the results by score (in opposite order of appearance, since the -// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. -const _orderResultsByScoreThenName = (a, b) => { - const leftScore = a[4]; - const rightScore = b[4]; - if (leftScore === rightScore) { - // same score: sort alphabetically - const leftTitle = a[1].toLowerCase(); - const rightTitle = b[1].toLowerCase(); - if (leftTitle === rightTitle) return 0; - return leftTitle > rightTitle ? -1 : 1; // inverted is intentional - } - return leftScore > rightScore ? 1 : -1; -}; - -/** - * Default splitQuery function. Can be overridden in ``sphinx.search`` with a - * custom function per language. - * - * The regular expression works by splitting the string on consecutive characters - * that are not Unicode letters, numbers, underscores, or emoji characters. - * This is the same as ``\W+`` in Python, preserving the surrogate pair area. - */ -if (typeof splitQuery === "undefined") { - var splitQuery = (query) => query - .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) - .filter(term => term) // remove remaining empty strings -} - -/** - * Search Module - */ -const Search = { - _index: null, - _queued_query: null, - _pulse_status: -1, - - htmlToText: (htmlString, anchor) => { - const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); - for (const removalQuery of [".headerlink", "script", "style"]) { - htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); - } - if (anchor) { - const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`); - if (anchorContent) return anchorContent.textContent; - - console.warn( - `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.` - ); - } - - // if anchor not specified or not found, fall back to main content - const docContent = htmlElement.querySelector('[role="main"]'); - if (docContent) return docContent.textContent; - - console.warn( - "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template." - ); - return ""; - }, - - init: () => { - const query = new URLSearchParams(window.location.search).get("q"); - document - .querySelectorAll('input[name="q"]') - .forEach((el) => (el.value = query)); - if (query) Search.performSearch(query); - }, - - loadIndex: (url) => - (document.body.appendChild(document.createElement("script")).src = url), - - setIndex: (index) => { - Search._index = index; - if (Search._queued_query !== null) { - const query = Search._queued_query; - Search._queued_query = null; - Search.query(query); - } - }, - - hasIndex: () => Search._index !== null, - - deferQuery: (query) => (Search._queued_query = query), - - stopPulse: () => (Search._pulse_status = -1), - - startPulse: () => { - if (Search._pulse_status >= 0) return; - - const pulse = () => { - Search._pulse_status = (Search._pulse_status + 1) % 4; - Search.dots.innerText = ".".repeat(Search._pulse_status); - if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); - }; - pulse(); - }, - - /** - * perform a search for something (or wait until index is loaded) - */ - performSearch: (query) => { - // create the required interface elements - const searchText = document.createElement("h2"); - searchText.textContent = _("Searching"); - const searchSummary = document.createElement("p"); - searchSummary.classList.add("search-summary"); - searchSummary.innerText = ""; - const searchList = document.createElement("ul"); - searchList.classList.add("search"); - - const out = document.getElementById("search-results"); - Search.title = out.appendChild(searchText); - Search.dots = Search.title.appendChild(document.createElement("span")); - Search.status = out.appendChild(searchSummary); - Search.output = out.appendChild(searchList); - - const searchProgress = document.getElementById("search-progress"); - // Some themes don't use the search progress node - if (searchProgress) { - searchProgress.innerText = _("Preparing search..."); - } - Search.startPulse(); - - // index already loaded, the browser was quick! - if (Search.hasIndex()) Search.query(query); - else Search.deferQuery(query); - }, - - _parseQuery: (query) => { - // stem the search terms and add them to the correct list - const stemmer = new Stemmer(); - const searchTerms = new Set(); - const excludedTerms = new Set(); - const highlightTerms = new Set(); - const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); - splitQuery(query.trim()).forEach((queryTerm) => { - const queryTermLower = queryTerm.toLowerCase(); - - // maybe skip this "word" - // stopwords array is from language_data.js - if ( - stopwords.indexOf(queryTermLower) !== -1 || - queryTerm.match(/^\d+$/) - ) - return; - - // stem the word - let word = stemmer.stemWord(queryTermLower); - // select the correct list - if (word[0] === "-") excludedTerms.add(word.substr(1)); - else { - searchTerms.add(word); - highlightTerms.add(queryTermLower); - } - }); - - if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js - localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) - } - - // console.debug("SEARCH: searching for:"); - // console.info("required: ", [...searchTerms]); - // console.info("excluded: ", [...excludedTerms]); - - return [query, searchTerms, excludedTerms, highlightTerms, objectTerms]; - }, - - /** - * execute search (requires search index to be loaded) - */ - _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => { - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const titles = Search._index.titles; - const allTitles = Search._index.alltitles; - const indexEntries = Search._index.indexentries; - - // Collect multiple result groups to be sorted separately and then ordered. - // Each is an array of [docname, title, anchor, descr, score, filename]. - const normalResults = []; - const nonMainIndexResults = []; - - _removeChildren(document.getElementById("search-progress")); - - const queryLower = query.toLowerCase().trim(); - for (const [title, foundTitles] of Object.entries(allTitles)) { - if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { - for (const [file, id] of foundTitles) { - const score = Math.round(Scorer.title * queryLower.length / title.length); - const boost = titles[file] === title ? 1 : 0; // add a boost for document titles - normalResults.push([ - docNames[file], - titles[file] !== title ? `${titles[file]} > ${title}` : title, - id !== null ? "#" + id : "", - null, - score + boost, - filenames[file], - ]); - } - } - } - - // search for explicit entries in index directives - for (const [entry, foundEntries] of Object.entries(indexEntries)) { - if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { - for (const [file, id, isMain] of foundEntries) { - const score = Math.round(100 * queryLower.length / entry.length); - const result = [ - docNames[file], - titles[file], - id ? "#" + id : "", - null, - score, - filenames[file], - ]; - if (isMain) { - normalResults.push(result); - } else { - nonMainIndexResults.push(result); - } - } - } - } - - // lookup as object - objectTerms.forEach((term) => - normalResults.push(...Search.performObjectSearch(term, objectTerms)) - ); - - // lookup as search terms in fulltext - normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms)); - - // let the scorer override scores with a custom scoring function - if (Scorer.score) { - normalResults.forEach((item) => (item[4] = Scorer.score(item))); - nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item))); - } - - // Sort each group of results by score and then alphabetically by name. - normalResults.sort(_orderResultsByScoreThenName); - nonMainIndexResults.sort(_orderResultsByScoreThenName); - - // Combine the result groups in (reverse) order. - // Non-main index entries are typically arbitrary cross-references, - // so display them after other results. - let results = [...nonMainIndexResults, ...normalResults]; - - // remove duplicate search results - // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept - let seen = new Set(); - results = results.reverse().reduce((acc, result) => { - let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); - if (!seen.has(resultStr)) { - acc.push(result); - seen.add(resultStr); - } - return acc; - }, []); - - return results.reverse(); - }, - - query: (query) => { - const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query); - const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms); - - // for debugging - //Search.lastresults = results.slice(); // a copy - // console.info("search results:", Search.lastresults); - - // print the results - _displayNextItem(results, results.length, searchTerms, highlightTerms); - }, - - /** - * search for object names - */ - performObjectSearch: (object, objectTerms) => { - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const objects = Search._index.objects; - const objNames = Search._index.objnames; - const titles = Search._index.titles; - - const results = []; - - const objectSearchCallback = (prefix, match) => { - const name = match[4] - const fullname = (prefix ? prefix + "." : "") + name; - const fullnameLower = fullname.toLowerCase(); - if (fullnameLower.indexOf(object) < 0) return; - - let score = 0; - const parts = fullnameLower.split("."); - - // check for different match types: exact matches of full name or - // "last name" (i.e. last dotted part) - if (fullnameLower === object || parts.slice(-1)[0] === object) - score += Scorer.objNameMatch; - else if (parts.slice(-1)[0].indexOf(object) > -1) - score += Scorer.objPartialMatch; // matches in last name - - const objName = objNames[match[1]][2]; - const title = titles[match[0]]; - - // If more than one term searched for, we require other words to be - // found in the name/title/description - const otherTerms = new Set(objectTerms); - otherTerms.delete(object); - if (otherTerms.size > 0) { - const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); - if ( - [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) - ) - return; - } - - let anchor = match[3]; - if (anchor === "") anchor = fullname; - else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; - - const descr = objName + _(", in ") + title; - - // add custom score for some objects according to scorer - if (Scorer.objPrio.hasOwnProperty(match[2])) - score += Scorer.objPrio[match[2]]; - else score += Scorer.objPrioDefault; - - results.push([ - docNames[match[0]], - fullname, - "#" + anchor, - descr, - score, - filenames[match[0]], - ]); - }; - Object.keys(objects).forEach((prefix) => - objects[prefix].forEach((array) => - objectSearchCallback(prefix, array) - ) - ); - return results; - }, - - /** - * search for full-text terms in the index - */ - performTermsSearch: (searchTerms, excludedTerms) => { - // prepare search - const terms = Search._index.terms; - const titleTerms = Search._index.titleterms; - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const titles = Search._index.titles; - - const scoreMap = new Map(); - const fileMap = new Map(); - - // perform the search on the required terms - searchTerms.forEach((word) => { - const files = []; - const arr = [ - { files: terms[word], score: Scorer.term }, - { files: titleTerms[word], score: Scorer.title }, - ]; - // add support for partial matches - if (word.length > 2) { - const escapedWord = _escapeRegExp(word); - if (!terms.hasOwnProperty(word)) { - Object.keys(terms).forEach((term) => { - if (term.match(escapedWord)) - arr.push({ files: terms[term], score: Scorer.partialTerm }); - }); - } - if (!titleTerms.hasOwnProperty(word)) { - Object.keys(titleTerms).forEach((term) => { - if (term.match(escapedWord)) - arr.push({ files: titleTerms[term], score: Scorer.partialTitle }); - }); - } - } - - // no match but word was a required one - if (arr.every((record) => record.files === undefined)) return; - - // found search word in contents - arr.forEach((record) => { - if (record.files === undefined) return; - - let recordFiles = record.files; - if (recordFiles.length === undefined) recordFiles = [recordFiles]; - files.push(...recordFiles); - - // set score for the word in each file - recordFiles.forEach((file) => { - if (!scoreMap.has(file)) scoreMap.set(file, {}); - scoreMap.get(file)[word] = record.score; - }); - }); - - // create the mapping - files.forEach((file) => { - if (!fileMap.has(file)) fileMap.set(file, [word]); - else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word); - }); - }); - - // now check if the files don't contain excluded terms - const results = []; - for (const [file, wordList] of fileMap) { - // check if all requirements are matched - - // as search terms with length < 3 are discarded - const filteredTermCount = [...searchTerms].filter( - (term) => term.length > 2 - ).length; - if ( - wordList.length !== searchTerms.size && - wordList.length !== filteredTermCount - ) - continue; - - // ensure that none of the excluded terms is in the search result - if ( - [...excludedTerms].some( - (term) => - terms[term] === file || - titleTerms[term] === file || - (terms[term] || []).includes(file) || - (titleTerms[term] || []).includes(file) - ) - ) - break; - - // select one (max) score for the file. - const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); - // add result to the result list - results.push([ - docNames[file], - titles[file], - "", - null, - score, - filenames[file], - ]); - } - return results; - }, - - /** - * helper function to return a node containing the - * search summary for a given text. keywords is a list - * of stemmed words. - */ - makeSearchSummary: (htmlText, keywords, anchor) => { - const text = Search.htmlToText(htmlText, anchor); - if (text === "") return null; - - const textLower = text.toLowerCase(); - const actualStartPosition = [...keywords] - .map((k) => textLower.indexOf(k.toLowerCase())) - .filter((i) => i > -1) - .slice(-1)[0]; - const startWithContext = Math.max(actualStartPosition - 120, 0); - - const top = startWithContext === 0 ? "" : "..."; - const tail = startWithContext + 240 < text.length ? "..." : ""; - - let summary = document.createElement("p"); - summary.classList.add("context"); - summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; - - return summary; - }, -}; - -_ready(Search.init); diff --git a/docs/_build/html/_static/sphinx_highlight.js b/docs/_build/html/_static/sphinx_highlight.js deleted file mode 100644 index 8a96c69..0000000 --- a/docs/_build/html/_static/sphinx_highlight.js +++ /dev/null @@ -1,154 +0,0 @@ -/* Highlighting utilities for Sphinx HTML documentation. */ -"use strict"; - -const SPHINX_HIGHLIGHT_ENABLED = true - -/** - * highlight a given string on a node by wrapping it in - * span elements with the given class name. - */ -const _highlight = (node, addItems, text, className) => { - if (node.nodeType === Node.TEXT_NODE) { - const val = node.nodeValue; - const parent = node.parentNode; - const pos = val.toLowerCase().indexOf(text); - if ( - pos >= 0 && - !parent.classList.contains(className) && - !parent.classList.contains("nohighlight") - ) { - let span; - - const closestNode = parent.closest("body, svg, foreignObject"); - const isInSVG = closestNode && closestNode.matches("svg"); - if (isInSVG) { - span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); - } else { - span = document.createElement("span"); - span.classList.add(className); - } - - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - const rest = document.createTextNode(val.substr(pos + text.length)); - parent.insertBefore( - span, - parent.insertBefore( - rest, - node.nextSibling - ) - ); - node.nodeValue = val.substr(0, pos); - /* There may be more occurrences of search term in this node. So call this - * function recursively on the remaining fragment. - */ - _highlight(rest, addItems, text, className); - - if (isInSVG) { - const rect = document.createElementNS( - "http://www.w3.org/2000/svg", - "rect" - ); - const bbox = parent.getBBox(); - rect.x.baseVal.value = bbox.x; - rect.y.baseVal.value = bbox.y; - rect.width.baseVal.value = bbox.width; - rect.height.baseVal.value = bbox.height; - rect.setAttribute("class", className); - addItems.push({ parent: parent, target: rect }); - } - } - } else if (node.matches && !node.matches("button, select, textarea")) { - node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); - } -}; -const _highlightText = (thisNode, text, className) => { - let addItems = []; - _highlight(thisNode, addItems, text, className); - addItems.forEach((obj) => - obj.parent.insertAdjacentElement("beforebegin", obj.target) - ); -}; - -/** - * Small JavaScript module for the documentation. - */ -const SphinxHighlight = { - - /** - * highlight the search words provided in localstorage in the text - */ - highlightSearchWords: () => { - if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight - - // get and clear terms from localstorage - const url = new URL(window.location); - const highlight = - localStorage.getItem("sphinx_highlight_terms") - || url.searchParams.get("highlight") - || ""; - localStorage.removeItem("sphinx_highlight_terms") - url.searchParams.delete("highlight"); - window.history.replaceState({}, "", url); - - // get individual terms from highlight string - const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); - if (terms.length === 0) return; // nothing to do - - // There should never be more than one element matching "div.body" - const divBody = document.querySelectorAll("div.body"); - const body = divBody.length ? divBody[0] : document.querySelector("body"); - window.setTimeout(() => { - terms.forEach((term) => _highlightText(body, term, "highlighted")); - }, 10); - - const searchBox = document.getElementById("searchbox"); - if (searchBox === null) return; - searchBox.appendChild( - document - .createRange() - .createContextualFragment( - '" - ) - ); - }, - - /** - * helper function to hide the search marks again - */ - hideSearchWords: () => { - document - .querySelectorAll("#searchbox .highlight-link") - .forEach((el) => el.remove()); - document - .querySelectorAll("span.highlighted") - .forEach((el) => el.classList.remove("highlighted")); - localStorage.removeItem("sphinx_highlight_terms") - }, - - initEscapeListener: () => { - // only install a listener if it is really needed - if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; - - document.addEventListener("keydown", (event) => { - // bail for input elements - if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; - // bail with special keys - if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; - if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { - SphinxHighlight.hideSearchWords(); - event.preventDefault(); - } - }); - }, -}; - -_ready(() => { - /* Do not call highlightSearchWords() when we are on the search page. - * It will highlight words from the *previous* search query. - */ - if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); - SphinxHighlight.initEscapeListener(); -}); diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html deleted file mode 100644 index 993822a..0000000 --- a/docs/_build/html/genindex.html +++ /dev/null @@ -1,611 +0,0 @@ - - - - - - Index — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
  • - -
  • -
  • -
-
-
-
-
- - -

Index

- -
- A - | B - | C - | D - | E - | F - | G - | H - | I - | J - | M - | N - | P - | R - | S - | T - | U - -
-

A

- - - -
- -

B

- - - -
- -

C

- - - -
- -

D

- - - -
- -

E

- - - -
- -

F

- - - -
- -

G

- - - -
- -

H

- - -
- -

I

- - - -
- -

J

- - - -
- -

M

- - -
- -

N

- - - -
- -

P

- - - -
- -

R

- - - -
- -

S

- - - -
- -

T

- - - -
- -

U

- - - -
- - - -
-
-
- -
- -
-

© Copyright 2024, Mathias Regnier & Tom Laclavère.

-
- - Built with Sphinx using a - theme - provided by Read the Docs. - - -
-
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html deleted file mode 100644 index 8745e7e..0000000 --- a/docs/_build/html/index.html +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - QUBIC Simulation Pipelines documentation — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

QUBIC Simulation Pipelines documentation

- -
- - -
-
-
- -
- -
-

© Copyright 2024, Mathias Regnier & Tom Laclavère.

-
- - Built with Sphinx using a - theme - provided by Read the Docs. - - -
-
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/modules.html b/docs/_build/html/modules.html deleted file mode 100644 index b4dcfd5..0000000 --- a/docs/_build/html/modules.html +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - CMM — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
- -
- -
- -
-

© Copyright 2024, Mathias Regnier & Tom Laclavère.

-
- - Built with Sphinx using a - theme - provided by Read the Docs. - - -
-
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv deleted file mode 100644 index 3093bb2..0000000 Binary files a/docs/_build/html/objects.inv and /dev/null differ diff --git a/docs/_build/html/py-modindex.html b/docs/_build/html/py-modindex.html deleted file mode 100644 index dae8e7a..0000000 --- a/docs/_build/html/py-modindex.html +++ /dev/null @@ -1,188 +0,0 @@ - - - - - - Python Module Index — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
  • - -
  • -
  • -
-
-
-
-
- - -

Python Module Index

- -
- c | - f -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 
- c
- CMM -
    - CMM.pipeline -
    - CMM.preset -
    - CMM.preset.preset_acquisition -
    - CMM.preset.preset_components -
    - CMM.preset.preset_external_data -
    - CMM.preset.preset_gain -
    - CMM.preset.preset_mixingmatrix -
    - CMM.preset.preset_qubic -
    - CMM.preset.preset_sky -
    - CMM.preset.preset_tools -
 
- f
- FMM -
    - FMM.pipeline -
- - -
-
-
- -
- -
-

© Copyright 2024, Mathias Regnier & Tom Laclavère.

-
- - Built with Sphinx using a - theme - provided by Read the Docs. - - -
-
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html deleted file mode 100644 index 02542a0..0000000 --- a/docs/_build/html/search.html +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - Search — QUBIC Simulation Pipelines 0.8 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
  • - -
  • -
  • -
-
-
-
-
- - - - -
- -
- -
-
-
- -
- -
-

© Copyright 2024, Mathias Regnier & Tom Laclavère.

-
- - Built with Sphinx using a - theme - provided by Read the Docs. - - -
-
-
-
-
- - - - - - - - - \ No newline at end of file diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js deleted file mode 100644 index 2afe34e..0000000 --- a/docs/_build/html/searchindex.js +++ /dev/null @@ -1 +0,0 @@ -Search.setIndex({"alltitles": {"CMM": [[16, null]], "CMM package": [[0, null]], "CMM.pipeline module": [[1, null]], "CMM.preset package": [[2, null]], "CMM.preset.preset_ module": [[3, null]], "CMM.preset.preset_acquisition module": [[4, null]], "CMM.preset.preset_components module": [[5, null]], "CMM.preset.preset_external_data module": [[6, null]], "CMM.preset.preset_gain module": [[7, null]], "CMM.preset.preset_mixingmatrix module": [[8, null]], "CMM.preset.preset_qubic module": [[9, null]], "CMM.preset.preset_sky module": [[10, null]], "CMM.preset.preset_tools module": [[11, null]], "Contents:": [[15, null]], "FMM package": [[12, null]], "FMM.main module": [[13, null]], "FMM.pipeline module": [[14, null]], "QUBIC Simulation Pipelines documentation": [[15, null]], "Submodules": [[0, "submodules"], [2, "submodules"], [12, "submodules"]], "Subpackages": [[0, "subpackages"]]}, "docnames": ["CMM", "CMM.pipeline", "CMM.preset", "CMM.preset.preset_", "CMM.preset.preset_acquisition", "CMM.preset.preset_components", "CMM.preset.preset_external_data", "CMM.preset.preset_gain", "CMM.preset.preset_mixingmatrix", "CMM.preset.preset_qubic", "CMM.preset.preset_sky", "CMM.preset.preset_tools", "FMM", "FMM.main", "FMM.pipeline", "index", "modules"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.viewcode": 1}, "filenames": ["CMM.rst", "CMM.pipeline.rst", "CMM.preset.rst", "CMM.preset.preset_.rst", "CMM.preset.preset_acquisition.rst", "CMM.preset.preset_components.rst", "CMM.preset.preset_external_data.rst", "CMM.preset.preset_gain.rst", "CMM.preset.preset_mixingmatrix.rst", "CMM.preset.preset_qubic.rst", "CMM.preset.preset_sky.rst", "CMM.preset.preset_tools.rst", "FMM.rst", "FMM.main.rst", "FMM.pipeline.rst", "index.rst", "modules.rst"], "indexentries": {"allbeta (cmm.preset.preset_acquisition.presetacquisition attribute)": [[4, "CMM.preset.preset_acquisition.PresetAcquisition.allbeta", false]], "amm_in (cmm.preset.preset_mixingmatrix.presetmixingmatrix attribute)": [[8, "CMM.preset.preset_mixingmatrix.PresetMixingMatrix.Amm_in", false], [8, "id2", false]], "amm_iter (cmm.preset.preset_acquisition.presetacquisition attribute)": [[4, "CMM.preset.preset_acquisition.PresetAcquisition.Amm_iter", false]], "beta_in (cmm.preset.preset_mixingmatrix.presetmixingmatrix attribute)": [[8, "CMM.preset.preset_mixingmatrix.PresetMixingMatrix.beta_in", false], [8, "id3", false]], "beta_iter (cmm.preset.preset_acquisition.presetacquisition attribute)": [[4, "CMM.preset.preset_acquisition.PresetAcquisition.beta_iter", false]], "call_pcg() (cmm.pipeline.pipeline method)": [[1, "CMM.pipeline.Pipeline.call_pcg", false]], "callback() (cmm.pipeline.pipeline method)": [[1, "CMM.pipeline.Pipeline.callback", false]], "center (cmm.preset.preset_sky.presetsky attribute)": [[10, "CMM.preset.preset_sky.PresetSky.center", false]], "check_for_errors() (cmm.preset.preset_tools.presettools method)": [[11, "CMM.preset.preset_tools.PresetTools.check_for_errors", false]], "cl2dl (cmm.preset.preset_sky.presetsky attribute)": [[10, "CMM.preset.preset_sky.PresetSky.cl2dl", false]], "cmm": [[0, "module-CMM", false]], "cmm.pipeline": [[1, "module-CMM.pipeline", false]], "cmm.preset": [[2, "module-CMM.preset", false]], "cmm.preset.preset_acquisition": [[4, "module-CMM.preset.preset_acquisition", false]], "cmm.preset.preset_components": [[5, "module-CMM.preset.preset_components", false]], "cmm.preset.preset_external_data": [[6, "module-CMM.preset.preset_external_data", false]], "cmm.preset.preset_gain": [[7, "module-CMM.preset.preset_gain", false]], "cmm.preset.preset_mixingmatrix": [[8, "module-CMM.preset.preset_mixingmatrix", false]], "cmm.preset.preset_qubic": [[9, "module-CMM.preset.preset_qubic", false]], "cmm.preset.preset_sky": [[10, "module-CMM.preset.preset_sky", false]], "cmm.preset.preset_tools": [[11, "module-CMM.preset.preset_tools", false]], "components (cmm.preset.preset_components.presetcomponents attribute)": [[5, "CMM.preset.preset_components.PresetComponents.components", false]], "components_convolved (cmm.preset.preset_components.presetcomponents attribute)": [[5, "CMM.preset.preset_components.PresetComponents.components_convolved", false]], "components_iter (cmm.preset.preset_components.presetcomponents attribute)": [[5, "CMM.preset.preset_components.PresetComponents.components_iter", false]], "components_model (cmm.preset.preset_components.presetcomponents attribute)": [[5, "CMM.preset.preset_components.PresetComponents.components_model", false]], "components_name (cmm.preset.preset_components.presetcomponents attribute)": [[5, "CMM.preset.preset_components.PresetComponents.components_name", false]], "coverage (cmm.preset.preset_sky.presetsky attribute)": [[10, "CMM.preset.preset_sky.PresetSky.coverage", false]], "create_folder_if_not_exists() (cmm.preset.preset_tools.presettools method)": [[11, "CMM.preset.preset_tools.PresetTools.create_folder_if_not_exists", false]], "dict (cmm.preset.preset_qubic.presetqubic attribute)": [[9, "CMM.preset.preset_qubic.PresetQubic.dict", false]], "display_simulation_configuration() (cmm.preset.preset_tools.presettools method)": [[11, "CMM.preset.preset_tools.PresetTools.display_simulation_configuration", false]], "ell (cmm.preset.preset_sky.presetsky attribute)": [[10, "CMM.preset.preset_sky.PresetSky.ell", false]], "external_nus (cmm.preset.preset_external_data.presetexternal attribute)": [[6, "CMM.preset.preset_external_data.PresetExternal.external_nus", false]], "extra_sed() (cmm.preset.preset_mixingmatrix.presetmixingmatrix method)": [[8, "CMM.preset.preset_mixingmatrix.PresetMixingMatrix.extra_sed", false]], "fisher() (cmm.pipeline.pipeline method)": [[1, "CMM.pipeline.Pipeline.fisher", false]], "fisher_compute_sigma_r() (cmm.pipeline.pipeline method)": [[1, "CMM.pipeline.Pipeline.fisher_compute_sigma_r", false]], "fmm": [[12, "module-FMM", false]], "fmm.pipeline": [[14, "module-FMM.pipeline", false]], "fwhm_rec (cmm.preset.preset_acquisition.presetacquisition attribute)": [[4, "CMM.preset.preset_acquisition.PresetAcquisition.fwhm_rec", false]], "get_approx_hth() (cmm.preset.preset_acquisition.presetacquisition method)": [[4, "CMM.preset.preset_acquisition.PresetAcquisition.get_approx_hth", false]], "get_averaged_nus() (fmm.pipeline.pipelinefrequencymapmaking method)": [[14, "FMM.pipeline.PipelineFrequencyMapMaking.get_averaged_nus", false]], "get_beta_input() (cmm.preset.preset_mixingmatrix.presetmixingmatrix method)": [[8, "CMM.preset.preset_mixingmatrix.PresetMixingMatrix.get_beta_input", false]], "get_components() (cmm.preset.preset_components.presetcomponents method)": [[5, "CMM.preset.preset_components.PresetComponents.get_components", false]], "get_components_fgb() (cmm.preset.preset_qubic.presetqubic method)": [[9, "CMM.preset.preset_qubic.PresetQubic.get_components_fgb", false]], "get_components_fgb() (fmm.pipeline.pipelinefrequencymapmaking method)": [[14, "FMM.pipeline.PipelineFrequencyMapMaking.get_components_fgb", false]], "get_constrains() (cmm.pipeline.pipeline method)": [[1, "CMM.pipeline.Pipeline.get_constrains", false]], "get_convolution() (cmm.preset.preset_acquisition.presetacquisition method)": [[4, "CMM.preset.preset_acquisition.PresetAcquisition.get_convolution", false]], "get_convolution() (fmm.pipeline.pipelinefrequencymapmaking method)": [[14, "FMM.pipeline.PipelineFrequencyMapMaking.get_convolution", false]], "get_coverage() (cmm.preset.preset_sky.presetsky method)": [[10, "CMM.preset.preset_sky.PresetSky.get_coverage", false]], "get_decorrelated_mixing_matrix() (cmm.preset.preset_mixingmatrix.presetmixingmatrix method)": [[8, "CMM.preset.preset_mixingmatrix.PresetMixingMatrix.get_decorrelated_mixing_matrix", false]], "get_dict() (cmm.preset.preset_qubic.presetqubic method)": [[9, "CMM.preset.preset_qubic.PresetQubic.get_dict", false]], "get_dict() (fmm.pipeline.pipelinefrequencymapmaking method)": [[14, "FMM.pipeline.PipelineFrequencyMapMaking.get_dict", false]], "get_external_nus() (cmm.preset.preset_external_data.presetexternal method)": [[6, "CMM.preset.preset_external_data.PresetExternal.get_external_nus", false]], "get_h() (fmm.pipeline.pipelinefrequencymapmaking method)": [[14, "FMM.pipeline.PipelineFrequencyMapMaking.get_H", false]], "get_index_seenpix_beta() (cmm.preset.preset_mixingmatrix.presetmixingmatrix method)": [[8, "CMM.preset.preset_mixingmatrix.PresetMixingMatrix.get_index_seenpix_beta", false]], "get_input_gain() (cmm.preset.preset_gain.presetgain method)": [[7, "CMM.preset.preset_gain.PresetGain.get_input_gain", false]], "get_input_map() (fmm.pipeline.pipelinefrequencymapmaking method)": [[14, "FMM.pipeline.PipelineFrequencyMapMaking.get_input_map", false]], "get_mixingmatrix() (cmm.preset.preset_mixingmatrix.presetmixingmatrix method)": [[8, "CMM.preset.preset_mixingmatrix.PresetMixingMatrix.get_mixingmatrix", false]], "get_noise() (cmm.preset.preset_acquisition.presetacquisition method)": [[4, "CMM.preset.preset_acquisition.PresetAcquisition.get_noise", false]], "get_preconditioner() (cmm.preset.preset_acquisition.presetacquisition method)": [[4, "CMM.preset.preset_acquisition.PresetAcquisition.get_preconditioner", false]], "get_preconditioner() (fmm.pipeline.pipelinefrequencymapmaking method)": [[14, "FMM.pipeline.PipelineFrequencyMapMaking.get_preconditioner", false]], "get_random_value() (fmm.pipeline.pipelinefrequencymapmaking method)": [[14, "FMM.pipeline.PipelineFrequencyMapMaking.get_random_value", false]], "get_sky_config() (cmm.preset.preset_components.presetcomponents method)": [[5, "CMM.preset.preset_components.PresetComponents.get_sky_config", false]], "get_sky_config() (fmm.pipeline.pipelinefrequencymapmaking method)": [[14, "FMM.pipeline.PipelineFrequencyMapMaking.get_sky_config", false]], "get_spectra_namaster_informations() (cmm.preset.preset_sky.presetsky method)": [[10, "CMM.preset.preset_sky.PresetSky.get_spectra_namaster_informations", false]], "get_tod() (cmm.preset.preset_acquisition.presetacquisition method)": [[4, "CMM.preset.preset_acquisition.PresetAcquisition.get_tod", false]], "get_tod() (fmm.pipeline.pipelinefrequencymapmaking method)": [[14, "FMM.pipeline.PipelineFrequencyMapMaking.get_tod", false]], "get_tod_comp() (cmm.pipeline.pipeline method)": [[1, "CMM.pipeline.Pipeline.get_tod_comp", false]], "get_tod_comp_superpixel() (cmm.pipeline.pipeline method)": [[1, "CMM.pipeline.Pipeline.get_tod_comp_superpixel", false]], "get_x0() (cmm.preset.preset_acquisition.presetacquisition method)": [[4, "CMM.preset.preset_acquisition.PresetAcquisition.get_x0", false]], "give_cl_cmb() (cmm.preset.preset_components.presetcomponents method)": [[5, "CMM.preset.preset_components.PresetComponents.give_cl_cmb", false]], "give_intercal() (cmm.pipeline.pipeline method)": [[1, "CMM.pipeline.Pipeline.give_intercal", false]], "h (cmm.preset.preset_acquisition.presetacquisition attribute)": [[4, "CMM.preset.preset_acquisition.PresetAcquisition.H", false], [4, "id0", false]], "initialize() (cmm.preset.presetinitialisation method)": [[2, "CMM.preset.PresetInitialisation.initialize", false]], "invn (cmm.preset.preset_acquisition.presetacquisition attribute)": [[4, "CMM.preset.preset_acquisition.PresetAcquisition.invN", false]], "ites_to_converge (cmm.preset.preset_acquisition.presetacquisition attribute)": [[4, "CMM.preset.preset_acquisition.PresetAcquisition.ites_to_converge", false]], "joint_in (cmm.preset.preset_qubic.presetqubic attribute)": [[9, "CMM.preset.preset_qubic.PresetQubic.joint_in", false]], "joint_out (cmm.preset.preset_qubic.presetqubic attribute)": [[9, "CMM.preset.preset_qubic.PresetQubic.joint_out", false]], "m (cmm.preset.preset_acquisition.presetacquisition attribute)": [[4, "CMM.preset.preset_acquisition.PresetAcquisition.M", false]], "main() (cmm.pipeline.pipeline method)": [[1, "CMM.pipeline.Pipeline.main", false]], "main() (fmm.pipeline.pipelineend2end method)": [[14, "FMM.pipeline.PipelineEnd2End.main", false]], "max_coverage (cmm.preset.preset_sky.presetsky attribute)": [[10, "CMM.preset.preset_sky.PresetSky.max_coverage", false]], "module": [[0, "module-CMM", false], [1, "module-CMM.pipeline", false], [2, "module-CMM.preset", false], [4, "module-CMM.preset.preset_acquisition", false], [5, "module-CMM.preset.preset_components", false], [6, "module-CMM.preset.preset_external_data", false], [7, "module-CMM.preset.preset_gain", false], [8, "module-CMM.preset.preset_mixingmatrix", false], [9, "module-CMM.preset.preset_qubic", false], [10, "module-CMM.preset.preset_sky", false], [11, "module-CMM.preset.preset_tools", false], [12, "module-FMM", false], [14, "module-FMM.pipeline", false]], "namaster (cmm.preset.preset_sky.presetsky attribute)": [[10, "CMM.preset.preset_sky.PresetSky.namaster", false]], "nsampling_x_ndetectors (cmm.preset.preset_acquisition.presetacquisition attribute)": [[4, "CMM.preset.preset_acquisition.PresetAcquisition.nsampling_x_ndetectors", false]], "nu_co (cmm.preset.preset_components.presetcomponents attribute)": [[5, "CMM.preset.preset_components.PresetComponents.nu_co", false]], "nus_eff_in (cmm.preset.preset_mixingmatrix.presetmixingmatrix attribute)": [[8, "CMM.preset.preset_mixingmatrix.PresetMixingMatrix.nus_eff_in", false], [8, "id0", false]], "nus_eff_out (cmm.preset.preset_mixingmatrix.presetmixingmatrix attribute)": [[8, "CMM.preset.preset_mixingmatrix.PresetMixingMatrix.nus_eff_out", false], [8, "id1", false]], "params (cmm.preset.preset_tools.presettools attribute)": [[11, "CMM.preset.preset_tools.PresetTools.params", false]], "params_cmb (cmm.preset.preset_components.presetcomponents attribute)": [[5, "CMM.preset.preset_components.PresetComponents.params_cmb", false]], "params_foregrounds (cmm.preset.preset_acquisition.presetacquisition attribute)": [[4, "CMM.preset.preset_acquisition.PresetAcquisition.params_foregrounds", false]], "params_foregrounds (cmm.preset.preset_components.presetcomponents attribute)": [[5, "CMM.preset.preset_components.PresetComponents.params_foregrounds", false]], "pcg() (fmm.pipeline.pipelinefrequencymapmaking method)": [[14, "FMM.pipeline.PipelineFrequencyMapMaking.pcg", false]], "pipeline (class in cmm.pipeline)": [[1, "CMM.pipeline.Pipeline", false]], "pipelineend2end (class in fmm.pipeline)": [[14, "FMM.pipeline.PipelineEnd2End", false]], "pipelinefrequencymapmaking (class in fmm.pipeline)": [[14, "FMM.pipeline.PipelineFrequencyMapMaking", false]], "polarized_i() (cmm.preset.preset_components.presetcomponents method)": [[5, "CMM.preset.preset_components.PresetComponents.polarized_I", false]], "presetacquisition (class in cmm.preset.preset_acquisition)": [[4, "CMM.preset.preset_acquisition.PresetAcquisition", false]], "presetcomponents (class in cmm.preset.preset_components)": [[5, "CMM.preset.preset_components.PresetComponents", false]], "presetexternal (class in cmm.preset.preset_external_data)": [[6, "CMM.preset.preset_external_data.PresetExternal", false]], "presetgain (class in cmm.preset.preset_gain)": [[7, "CMM.preset.preset_gain.PresetGain", false]], "presetinitialisation (class in cmm.preset)": [[2, "CMM.preset.PresetInitialisation", false]], "presetmixingmatrix (class in cmm.preset.preset_mixingmatrix)": [[8, "CMM.preset.preset_mixingmatrix.PresetMixingMatrix", false]], "presetqubic (class in cmm.preset.preset_qubic)": [[9, "CMM.preset.preset_qubic.PresetQubic", false]], "presetsky (class in cmm.preset.preset_sky)": [[10, "CMM.preset.preset_sky.PresetSky", false]], "presettools (class in cmm.preset.preset_tools)": [[11, "CMM.preset.preset_tools.PresetTools", false]], "rms_tolerance (cmm.preset.preset_acquisition.presetacquisition attribute)": [[4, "CMM.preset.preset_acquisition.PresetAcquisition.rms_tolerance", false]], "run() (fmm.pipeline.pipelinefrequencymapmaking method)": [[14, "FMM.pipeline.PipelineFrequencyMapMaking.run", false]], "save_data() (cmm.pipeline.pipeline method)": [[1, "CMM.pipeline.Pipeline.save_data", false]], "seed (cmm.preset.preset_components.presetcomponents attribute)": [[5, "CMM.preset.preset_components.PresetComponents.seed", false]], "seed_noise (cmm.preset.preset_acquisition.presetacquisition attribute)": [[4, "CMM.preset.preset_acquisition.PresetAcquisition.seed_noise", false]], "seenpix (cmm.preset.preset_sky.presetsky attribute)": [[10, "CMM.preset.preset_sky.PresetSky.seenpix", false]], "seenpix_qubic (cmm.preset.preset_sky.presetsky attribute)": [[10, "CMM.preset.preset_sky.PresetSky.seenpix_qubic", false]], "skyconfig (cmm.preset.preset_components.presetcomponents attribute)": [[5, "CMM.preset.preset_components.PresetComponents.skyconfig", false]], "spectral_index_modifiedblackbody() (cmm.preset.preset_mixingmatrix.presetmixingmatrix method)": [[8, "CMM.preset.preset_mixingmatrix.PresetMixingMatrix.spectral_index_modifiedblackbody", false]], "spectral_index_powerlaw() (cmm.preset.preset_mixingmatrix.presetmixingmatrix method)": [[8, "CMM.preset.preset_mixingmatrix.PresetMixingMatrix.spectral_index_powerlaw", false]], "tod_external (cmm.preset.preset_acquisition.presetacquisition attribute)": [[4, "CMM.preset.preset_acquisition.PresetAcquisition.TOD_external", false], [4, "id2", false]], "tod_obs (cmm.preset.preset_acquisition.presetacquisition attribute)": [[4, "CMM.preset.preset_acquisition.PresetAcquisition.TOD_obs", false], [4, "id3", false]], "tod_qubic (cmm.preset.preset_acquisition.presetacquisition attribute)": [[4, "CMM.preset.preset_acquisition.PresetAcquisition.TOD_qubic", false], [4, "id1", false]], "update_components() (cmm.pipeline.pipeline method)": [[1, "CMM.pipeline.Pipeline.update_components", false]], "update_gain() (cmm.pipeline.pipeline method)": [[1, "CMM.pipeline.Pipeline.update_gain", false]], "update_mixing_matrix() (cmm.pipeline.pipeline method)": [[1, "CMM.pipeline.Pipeline.update_mixing_matrix", false]], "update_spectral_index() (cmm.pipeline.pipeline method)": [[1, "CMM.pipeline.Pipeline.update_spectral_index", false]]}, "objects": {"": [[0, 0, 0, "-", "CMM"], [12, 0, 0, "-", "FMM"]], "CMM": [[1, 0, 0, "-", "pipeline"], [2, 0, 0, "-", "preset"]], "CMM.pipeline": [[1, 1, 1, "", "Pipeline"]], "CMM.pipeline.Pipeline": [[1, 2, 1, "", "call_pcg"], [1, 2, 1, "", "callback"], [1, 2, 1, "", "fisher"], [1, 2, 1, "", "fisher_compute_sigma_r"], [1, 2, 1, "", "get_constrains"], [1, 2, 1, "", "get_tod_comp"], [1, 2, 1, "", "get_tod_comp_superpixel"], [1, 2, 1, "", "give_intercal"], [1, 2, 1, "", "main"], [1, 2, 1, "", "save_data"], [1, 2, 1, "", "update_components"], [1, 2, 1, "", "update_gain"], [1, 2, 1, "", "update_mixing_matrix"], [1, 2, 1, "", "update_spectral_index"]], "CMM.preset": [[2, 1, 1, "", "PresetInitialisation"], [4, 0, 0, "-", "preset_acquisition"], [5, 0, 0, "-", "preset_components"], [6, 0, 0, "-", "preset_external_data"], [7, 0, 0, "-", "preset_gain"], [8, 0, 0, "-", "preset_mixingmatrix"], [9, 0, 0, "-", "preset_qubic"], [10, 0, 0, "-", "preset_sky"], [11, 0, 0, "-", "preset_tools"]], "CMM.preset.PresetInitialisation": [[2, 2, 1, "", "initialize"]], "CMM.preset.preset_acquisition": [[4, 1, 1, "", "PresetAcquisition"]], "CMM.preset.preset_acquisition.PresetAcquisition": [[4, 3, 1, "", "Amm_iter"], [4, 3, 1, "id0", "H"], [4, 3, 1, "", "M"], [4, 3, 1, "id2", "TOD_external"], [4, 3, 1, "id3", "TOD_obs"], [4, 3, 1, "id1", "TOD_qubic"], [4, 3, 1, "", "allbeta"], [4, 3, 1, "", "beta_iter"], [4, 3, 1, "", "fwhm_rec"], [4, 2, 1, "", "get_approx_hth"], [4, 2, 1, "", "get_convolution"], [4, 2, 1, "", "get_noise"], [4, 2, 1, "", "get_preconditioner"], [4, 2, 1, "", "get_tod"], [4, 2, 1, "", "get_x0"], [4, 3, 1, "", "invN"], [4, 3, 1, "", "ites_to_converge"], [4, 3, 1, "", "nsampling_x_ndetectors"], [4, 3, 1, "", "params_foregrounds"], [4, 3, 1, "", "rms_tolerance"], [4, 3, 1, "", "seed_noise"]], "CMM.preset.preset_components": [[5, 1, 1, "", "PresetComponents"]], "CMM.preset.preset_components.PresetComponents": [[5, 3, 1, "", "components"], [5, 3, 1, "", "components_convolved"], [5, 3, 1, "", "components_iter"], [5, 3, 1, "", "components_model"], [5, 3, 1, "", "components_name"], [5, 2, 1, "", "get_components"], [5, 2, 1, "", "get_sky_config"], [5, 2, 1, "", "give_cl_cmb"], [5, 3, 1, "", "nu_co"], [5, 3, 1, "", "params_cmb"], [5, 3, 1, "", "params_foregrounds"], [5, 2, 1, "", "polarized_I"], [5, 3, 1, "", "seed"], [5, 3, 1, "", "skyconfig"]], "CMM.preset.preset_external_data": [[6, 1, 1, "", "PresetExternal"]], "CMM.preset.preset_external_data.PresetExternal": [[6, 3, 1, "", "external_nus"], [6, 2, 1, "", "get_external_nus"]], "CMM.preset.preset_gain": [[7, 1, 1, "", "PresetGain"]], "CMM.preset.preset_gain.PresetGain": [[7, 2, 1, "", "get_input_gain"]], "CMM.preset.preset_mixingmatrix": [[8, 1, 1, "", "PresetMixingMatrix"]], "CMM.preset.preset_mixingmatrix.PresetMixingMatrix": [[8, 3, 1, "id2", "Amm_in"], [8, 3, 1, "id3", "beta_in"], [8, 2, 1, "", "extra_sed"], [8, 2, 1, "", "get_beta_input"], [8, 2, 1, "", "get_decorrelated_mixing_matrix"], [8, 2, 1, "", "get_index_seenpix_beta"], [8, 2, 1, "", "get_mixingmatrix"], [8, 3, 1, "id0", "nus_eff_in"], [8, 3, 1, "id1", "nus_eff_out"], [8, 2, 1, "", "spectral_index_modifiedblackbody"], [8, 2, 1, "", "spectral_index_powerlaw"]], "CMM.preset.preset_qubic": [[9, 1, 1, "", "PresetQubic"]], "CMM.preset.preset_qubic.PresetQubic": [[9, 3, 1, "", "dict"], [9, 2, 1, "", "get_components_fgb"], [9, 2, 1, "", "get_dict"], [9, 3, 1, "", "joint_in"], [9, 3, 1, "", "joint_out"]], "CMM.preset.preset_sky": [[10, 1, 1, "", "PresetSky"]], "CMM.preset.preset_sky.PresetSky": [[10, 3, 1, "", "center"], [10, 3, 1, "", "cl2dl"], [10, 3, 1, "", "coverage"], [10, 3, 1, "", "ell"], [10, 2, 1, "", "get_coverage"], [10, 2, 1, "", "get_spectra_namaster_informations"], [10, 3, 1, "", "max_coverage"], [10, 3, 1, "", "namaster"], [10, 3, 1, "", "seenpix"], [10, 3, 1, "", "seenpix_qubic"]], "CMM.preset.preset_tools": [[11, 1, 1, "", "PresetTools"]], "CMM.preset.preset_tools.PresetTools": [[11, 2, 1, "", "check_for_errors"], [11, 2, 1, "", "create_folder_if_not_exists"], [11, 2, 1, "", "display_simulation_configuration"], [11, 3, 1, "", "params"]], "FMM": [[14, 0, 0, "-", "pipeline"]], "FMM.pipeline": [[14, 1, 1, "", "PipelineEnd2End"], [14, 1, 1, "", "PipelineFrequencyMapMaking"]], "FMM.pipeline.PipelineEnd2End": [[14, 2, 1, "", "main"]], "FMM.pipeline.PipelineFrequencyMapMaking": [[14, 2, 1, "", "get_H"], [14, 2, 1, "", "get_averaged_nus"], [14, 2, 1, "", "get_components_fgb"], [14, 2, 1, "", "get_convolution"], [14, 2, 1, "", "get_dict"], [14, 2, 1, "", "get_input_map"], [14, 2, 1, "", "get_preconditioner"], [14, 2, 1, "", "get_random_value"], [14, 2, 1, "", "get_sky_config"], [14, 2, 1, "", "get_tod"], [14, 2, 1, "", "pcg"], [14, 2, 1, "", "run"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute"}, "terms": {"": 14, "0": [1, 4, 5, 10, 11], "1": [1, 4, 5, 8, 10, 14], "12": [4, 14], "2": [1, 4, 14], "3": [1, 4, 5], "4": 1, "42": 5, "5": 1, "54": 8, "A": [1, 4, 10], "For": 14, "If": [1, 4, 6, 8, 11, 14], "In": 8, "It": [1, 4, 5, 6, 7, 8, 9, 10, 11, 14], "The": [1, 4, 5, 7, 8, 11, 14], "To": 14, "_": 14, "_invn": 1, "a_ext": 4, "a_qub": 4, "abil": [1, 14], "about": 11, "access": [5, 8], "accord": [5, 8, 10, 14], "acquisit": [4, 14], "across": 8, "action": 1, "ad": [6, 14], "adeco": 8, "adjust": 7, "after": 14, "alen": 5, "algorithm": [1, 4, 14], "all": [1, 2, 4, 9, 10, 11, 14], "all_gain": 7, "all_gain_in": 7, "all_gain_it": 7, "allbeta": [2, 4], "alreadi": 11, "also": 4, "amm": 8, "amm_in": [2, 8], "amm_it": [2, 4], "amplitud": 5, "an": [1, 4], "analysi": 10, "analyt": [1, 14], "angular": [4, 10, 14], "ani": 11, "appli": [1, 4, 14], "appropri": 4, "approx": 4, "approx_hth": 4, "approx_hth_ext": 4, "approxim": 4, "ar": [1, 7, 10], "argument": 4, "arrai": [1, 4, 5, 8, 10, 14], "array_lik": [1, 4, 5, 8, 10, 14], "associ": [1, 4, 5], "assum": 8, "astrophys": [4, 5], "attribut": [4, 7], "averag": 14, "band": [1, 4], "barrier": 1, "base": [1, 2, 4, 5, 6, 7, 8, 9, 10, 11, 14], "bb": 5, "beam": 4, "befor": 1, "beta": [1, 4, 8, 10], "beta_in": [2, 8], "beta_it": [2, 4], "between": 10, "blind": 1, "blockcolumnoper": 4, "blockdiagonaloper": 4, "bool": [4, 14], "boolean": [1, 10, 14], "build": [9, 14], "c": [1, 4], "c_": [5, 10], "calcul": [1, 4, 5, 8, 10], "call": [1, 8], "call_pcg": [0, 1], "callback": [0, 1], "can": [4, 5, 8, 9, 14], "caracterist": 9, "case": 8, "cdot": 14, "center": [2, 10], "cf": 1, "check": [4, 6, 11], "check_for_error": [2, 11], "chosen": [5, 8, 10], "cl2dl": [2, 10], "class": [1, 2, 4, 5, 6, 7, 8, 9, 10, 11, 14], "closest": 10, "cmb": [1, 2, 5, 14], "cmm": 15, "combin": 4, "come": 5, "comm": [1, 2, 11, 14], "comm_world": [1, 2, 11], "common": [1, 2, 11], "commun": [1, 2, 11, 14], "comp": [1, 4], "compoen": [5, 8], "compon": [1, 2, 4, 5, 6, 7, 8, 9, 10, 11, 14], "components_convolv": [2, 5], "components_it": [2, 5], "components_model": [2, 5], "components_nam": [2, 5], "comput": [1, 10, 14], "config": 14, "configur": [5, 8, 11, 14], "conjug": [1, 14], "constraint": 1, "contain": [1, 4, 5, 6, 7, 8, 9, 10, 11, 14], "contamin": 4, "contribut": 5, "convent": 14, "converg": [1, 4], "convers": 10, "convolut": [1, 4, 14], "convolution_in": 4, "convolution_out": 4, "convolv": [4, 5], "correl": 8, "correlation_length": 8, "cosin": 5, "counter": 1, "covari": [1, 4], "cover": 10, "coverag": [2, 10], "creat": [4, 6, 10, 11, 14], "create_folder_if_not_exist": [2, 11], "current": 1, "d": [1, 4, 14], "d0": [5, 8, 14], "d1": [4, 8], "d6": 8, "d_": 10, "data": [1, 4, 6, 14], "dec": 10, "decid": 4, "decim": 1, "decorrealt": 8, "decorrel": 8, "decrib": 1, "default": [1, 4, 5, 8, 9, 14], "defin": [1, 2, 4, 5, 6, 7, 8, 9, 10, 11, 14], "denot": 14, "depend": 4, "descript": 8, "design": 1, "det": 4, "detail": 11, "detector": [1, 4, 7], "determin": 4, "diagon": 1, "diagonaloper": [4, 14], "dict": [2, 4, 5, 9, 11, 14], "dict_comp": [9, 14], "dict_qub": [9, 14], "dict_ski": 14, "dictionari": [1, 4, 5, 9, 11, 14], "differ": 11, "dimens": 1, "displai": 11, "display_simulation_configur": [2, 11], "distanc": 10, "distribut": [7, 8], "doe": [5, 11], "don": 14, "dual": 4, "dure": [1, 14], "dust": [5, 8, 14], "e": 14, "each": [1, 4, 5], "effect": 8, "egal": 14, "either": [4, 5, 8], "ell": [1, 2, 5, 10], "emiss": [5, 14], "encount": 4, "end": 14, "energi": 8, "ensur": 1, "equat": [1, 14], "error": 11, "estim": 1, "evalu": 14, "everi": [1, 5], "exampl": [5, 14], "exist": [5, 11], "expect": 14, "experi": 4, "extern": [4, 6], "external_nu": [2, 6], "extra": 8, "extra_s": [2, 8], "factor": [4, 10], "fail": 11, "fake": [4, 5], "fals": 14, "fgbuster": [5, 8, 9, 14], "file": [2, 6, 11, 14], "fill": 1, "fisher": [0, 1], "fisher_compute_sigma_r": [0, 1], "fit": 1, "fix": 8, "flatten": 4, "float": [1, 4, 5, 8, 10], "fmm": 15, "folder": 11, "folder_nam": 11, "follow": [1, 4], "foreground": [4, 5], "forlder": 14, "form": 1, "formula": [1, 4, 14], "frac": 1, "fraction": 5, "frequenc": [4, 5, 6, 8, 14], "from": [1, 4, 5, 8, 10, 14], "full": 4, "function": [1, 10, 11, 14], "fwhm": 4, "fwhm_in": 14, "fwhm_mapmak": 4, "fwhm_out": 14, "fwhm_rec": [2, 4, 14], "fwhm_tod": 4, "g": [1, 4, 14], "gain": [1, 4, 7], "gain_in": 7, "gain_it": 7, "gener": [1, 4, 5, 7, 9, 14], "get": [8, 14], "get_approx_hth": [2, 4], "get_averaged_nu": [12, 14], "get_beta_input": [2, 8], "get_compon": [2, 5], "get_components_fgb": [2, 9, 12, 14], "get_constrain": [0, 1], "get_convolut": [2, 4, 12, 14], "get_coverag": [2, 10], "get_decorrelated_mixing_matrix": [2, 8], "get_dict": [2, 9, 12, 14], "get_external_nu": [2, 6], "get_h": [12, 14], "get_index_seenpix_beta": [2, 8], "get_input_gain": [2, 7], "get_input_map": [12, 14], "get_mixingmatrix": [2, 8], "get_nois": [2, 4], "get_precondition": [2, 4, 12, 14], "get_random_valu": [12, 14], "get_sky_config": [2, 5, 12, 14], "get_spectra_namaster_inform": [2, 10], "get_tod": [2, 4, 12, 14], "get_tod_comp": [0, 1], "get_tod_comp_superpixel": [0, 1], "get_x0": [2, 4], "give_cl_cmb": [2, 5], "give_interc": [0, 1], "given": [1, 4, 8], "gradiant": [1, 14], "h": [1, 2, 4, 14], "h_i": 1, "half": 4, "healpix": [5, 8], "hth": 4, "hybrid": 1, "i": [1, 4, 5, 6, 8, 9, 11, 14], "icomp": 1, "implement": 8, "includ": [4, 11], "incorrect": 8, "increment": 1, "indeic": 4, "index": [1, 8], "indic": [4, 8], "initi": [0, 1, 2, 4, 5, 6, 7, 8, 9, 10, 11], "initil": 5, "input": [4, 5, 7, 8, 11, 14], "instanc": [1, 2, 4, 5, 6, 7, 8, 9, 10, 11, 14], "instanti": 4, "instrument": [4, 7, 10, 11, 14], "int": [1, 2, 4, 5, 8, 14], "integr": 1, "intend": 1, "intens": 5, "intercalibr": 1, "intermedi": 1, "intial": 9, "intrins": 14, "intrinsequ": 14, "intrument": 9, "invers": [1, 4], "invn": [2, 4], "iter": [1, 4, 5, 14], "ites_to_converg": [2, 4], "joint_in": [2, 9], "joint_out": [2, 9], "kei": [5, 8, 9, 14], "know": 1, "lcorr": 8, "lenght": 8, "lens": 5, "list": [1, 5, 6], "m": [2, 4, 5, 14], "mai": 7, "main": [0, 1, 12, 14], "make": [1, 2, 4, 5, 6, 7, 8, 9, 10, 11, 14], "map": [1, 2, 4, 5, 6, 7, 8, 9, 10, 11, 14], "maps_in": 14, "mark": 10, "mask": 10, "matrix": [1, 4, 8], "max": 4, "max_coverag": [2, 10], "max_iter": 1, "maximum": [1, 4, 10], "mbb_index": 8, "method": [1, 2, 4, 5, 6, 7, 8, 9, 10, 11, 14], "minim": [1, 14], "mix": [1, 4, 8], "model": [1, 4, 5, 8, 14], "modifi": [9, 14], "modifiedblackbodi": 8, "modul": [0, 2, 12, 16], "monochromat": 5, "mpi": [1, 2, 11, 14], "multipl": 1, "multipli": [1, 4], "multipol": [1, 10], "n": [1, 4, 14], "n_": [1, 4, 14], "namast": [2, 10], "name": [4, 5, 11], "nbeta": 8, "ncomp": 8, "ndet": 4, "nfev": 1, "nl": 1, "nois": [1, 2, 4, 5, 14], "none": [1, 5, 14], "normal": 7, "note": 14, "npho_150": 4, "npho_220": 4, "nsampling_x_ndetector": [2, 4], "nside": [5, 8], "nside_": 4, "nu": 8, "nu_co": [2, 5], "number": [1, 4, 10, 14], "numpi": 1, "nus_av": 14, "nus_eff_in": [2, 8], "nus_eff_out": [2, 8], "ob": 1, "object": [1, 2, 4, 5, 6, 7, 8, 9, 10, 11, 14], "observ": [1, 4, 10, 14], "obtain": 1, "one": 14, "onli": [1, 11], "openmp": 1, "oper": [1, 4, 5, 7, 8, 10, 14], "optim": [1, 4], "option": [1, 4, 5, 8, 9, 14], "order": [1, 4], "other": 14, "otherwis": [8, 14], "out": [5, 8, 9, 11, 14], "output": [4, 8, 11, 14], "over": 1, "p_map": 5, "packag": [1, 15, 16], "paper": 1, "parallel": 14, "param": [1, 2, 6, 10, 11, 14], "paramet": [1, 2, 4, 5, 6, 7, 8, 9, 10, 11, 14], "parametr": 1, "params_cmb": [2, 5], "params_foreground": [2, 4, 5], "paramt": 4, "patch": 10, "pcg": [1, 4, 12, 14], "perform": 1, "pipelin": [0, 2, 12, 16], "pipelineend2end": [12, 14], "pipelinefrequencymapmak": [12, 14], "pix": 4, "pixel": [1, 4, 10, 14], "pl_index": 8, "place": 1, "planck": [1, 4, 6], "point": [1, 4, 10, 14], "polar": 5, "polaris": 5, "polarization_fract": 5, "polarized_i": [2, 5], "possibl": 1, "power": [1, 5, 10], "power_spectrum": 5, "powerlaw": 8, "precond": 4, "precondit": 14, "precondition": [4, 14], "precont": 1, "precontion": 4, "presenc": 6, "present": 6, "preset": [0, 1, 16], "preset_": [0, 2], "preset_acquisit": [0, 2], "preset_comp": [4, 8], "preset_compon": [0, 2], "preset_extern": [4, 9], "preset_external_data": [0, 2], "preset_gain": [0, 2, 4], "preset_mixing_matrix": 4, "preset_mixingmatrix": [0, 2], "preset_qub": [0, 2, 4, 5, 7, 8, 10], "preset_ski": [0, 2, 4], "preset_tool": [0, 2, 4, 5, 6, 7, 8, 9, 10], "presetacquisit": [0, 2, 4], "presetcompon": [0, 2, 5], "presetextern": [0, 2, 6], "presetgain": [0, 2, 7], "presetinitialis": [0, 2, 16], "presetmixingmatrix": [0, 2, 8], "presetqub": [0, 2, 9], "presetsim": 1, "presetski": [0, 2, 10], "presettool": [0, 2, 11], "prest": [5, 8], "previou": [1, 8], "previous": 14, "previous_mixingmatrix": 1, "print": [1, 11], "proceed": 1, "process": [1, 4, 7, 11], "produc": 1, "product": 1, "pyoper": [1, 14], "pysm": [5, 14], "pysm3": [5, 14], "python": 6, "qubic": [1, 4, 5, 7, 8, 9, 10, 11, 14], "qubicdualbandnois": 4, "qubicwidebandnois": 4, "r": [1, 5], "ra": 10, "radian": [4, 14], "rais": [4, 5, 8, 11], "random": [1, 2, 4, 5, 8, 14], "randomli": 5, "rank": [1, 11], "ratio": 5, "reach": 1, "read": [1, 2, 5, 6, 14], "readabl": 1, "real": 4, "realiz": [1, 2, 4, 14], "rec": 14, "reconstruct": [1, 4, 5, 9, 10, 14], "rel": 5, "repeat": 1, "repres": 4, "reshap": 1, "resolut": [4, 14], "respect": [9, 14], "return": [1, 2, 4, 5, 6, 8, 9, 10, 14], "rms_toler": [2, 4], "root": 1, "round": 1, "run": [1, 12, 14], "s0": 14, "s1": 8, "sampl": [1, 4], "save": 14, "save_data": [0, 1], "scalar": 5, "scan": 10, "scipi": 1, "section": 6, "sed": 8, "see": 14, "seed": [1, 2, 4, 5, 8, 14], "seed_nois": [1, 2, 4, 5], "seen": [4, 10, 14], "seenpix": [1, 2, 8, 10, 14], "seenpix_qub": [2, 10], "select": 1, "self": [1, 4], "semi": 1, "sepctral": 1, "set": [4, 7, 10, 11], "set_comp_to_0": 4, "shape": [4, 8], "side": 14, "sigma": 1, "signal": 14, "sim": 1, "simlul": 1, "simul": [1, 4, 5, 6, 7, 8, 9, 10, 11, 14], "sine": 5, "sky": [4, 5, 8, 9, 10, 11, 14], "skyconfig": [2, 5], "solut": 14, "solv": [1, 14], "solver": 1, "sort": 10, "sourc": [1, 2, 4, 5, 6, 7, 8, 9, 10, 11, 14], "spatial": 8, "specif": [5, 6, 8], "specifi": [1, 4, 11], "specific_fil": 14, "spectral": [1, 4, 8], "spectral_index_modifiedblackbodi": [2, 8], "spectral_index_powerlaw": [2, 8], "spectrum": [1, 5, 10], "sphere": 10, "start": [4, 14], "step": 1, "stk": 14, "stoke": 4, "str": [5, 8, 9, 11, 14], "strategi": 10, "sub": [1, 4], "submodul": [15, 16], "subpackag": [15, 16], "synchron": 1, "synchrotron": [8, 14], "systemat": 4, "t": [1, 4, 14], "task": 11, "tell": 4, "tensor": 5, "thermal": 8, "thi": [1, 4, 6, 7, 8, 10, 11], "thr": 4, "threshold": [4, 10], "through": [10, 14], "time": [1, 4, 14], "tod": [1, 4, 9, 14], "tod_": 1, "tod_comp": 1, "tod_extern": [2, 4], "tod_ob": [2, 4], "tod_qub": [2, 4], "toler": 4, "tool": [4, 5, 6, 7, 8, 9, 10, 11], "total": 4, "true": [4, 14], "tupl": 10, "two": 1, "type": [1, 4, 5, 6, 7, 8, 9, 10, 11, 14], "typeerror": [4, 5, 8, 11], "u": 1, "ultra": 1, "uncov": 10, "under": 6, "unrecogn": 4, "until": 1, "up": 10, "updat": 1, "update_compon": [0, 1], "update_gain": [0, 1], "update_mixing_matrix": [0, 1], "update_spectral_index": [0, 1], "updated_mixingmatrix": 1, "us": [1, 2, 4, 5, 7, 8, 9, 10, 11, 14], "valu": [1, 4, 6, 7, 8, 14], "valueerror": 8, "varaibl": 4, "vari": 8, "variabl": [1, 4, 5, 6, 7, 8, 9, 10], "variou": 11, "vec": [1, 4, 14], "vector": 1, "want": [4, 5, 9, 10, 14], "we": [5, 14], "when": 1, "where": [1, 10], "which": 5, "whole": 14, "wide": [1, 4], "width": 4, "wrapper": 14, "x": [1, 14], "x0": 14, "x_planck": 1, "xi": 1, "yml": [1, 6, 10, 11, 14], "you": [4, 10, 14], "your": 14, "zero": [1, 14]}, "titles": ["CMM package", "CMM.pipeline module", "CMM.preset package", "CMM.preset.preset_ module", "CMM.preset.preset_acquisition module", "CMM.preset.preset_components module", "CMM.preset.preset_external_data module", "CMM.preset.preset_gain module", "CMM.preset.preset_mixingmatrix module", "CMM.preset.preset_qubic module", "CMM.preset.preset_sky module", "CMM.preset.preset_tools module", "FMM package", "FMM.main module", "FMM.pipeline module", "QUBIC Simulation Pipelines documentation", "CMM"], "titleterms": {"cmm": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 16], "content": 15, "document": 15, "fmm": [12, 13, 14], "main": 13, "modul": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 14], "packag": [0, 2, 12], "pipelin": [1, 14, 15], "preset": [2, 3, 4, 5, 6, 7, 8, 9, 10, 11], "preset_": 3, "preset_acquisit": 4, "preset_compon": 5, "preset_external_data": 6, "preset_gain": 7, "preset_mixingmatrix": 8, "preset_qub": 9, "preset_ski": 10, "preset_tool": 11, "qubic": 15, "simul": 15, "submodul": [0, 2, 12], "subpackag": 0}}) \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index c7926af..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,42 +0,0 @@ -# Configuration file for the Sphinx documentation builder. -# -# For the full list of built-in configuration values, see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -import sys -import os - -sys.path.insert(0, os.path.abspath('..')) - -# -- Project information ----------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information - -project = 'QUBIC Simulation Pipelines' -copyright = '2024, Mathias Regnier & Tom Laclavère' -author = 'Mathias Regnier & Tom Laclavère' -release = '0.8' - -# -- General configuration --------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration - -extensions = [ - "sphinx.ext.autodoc", - "sphinx.ext.doctest", - "sphinx.ext.intersphinx", - "sphinx.ext.napoleon", - "sphinx.ext.viewcode", - "sphinx.ext.githubpages", - 'sphinx_autodoc_typehints', - "numpydoc", - 'sphinx.ext.mathjax', -] - -templates_path = ['_templates'] -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - - -# -- Options for HTML output ------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output - -html_theme = 'sphinx_rtd_theme' -html_static_path = ['_static'] \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 0796419..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. QUBIC Simulation Pipelines documentation master file, created by - sphinx-quickstart on Thu Sep 5 15:33:17 2024. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -QUBIC Simulation Pipelines documentation -======================================== - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - CMM - FMM \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 32bb245..0000000 --- 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=. -set BUILDDIR=_build - -%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.https://www.sphinx-doc.org/ - exit /b 1 -) - -if "%1" == "" goto help - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd diff --git a/docs/modules.rst b/docs/modules.rst deleted file mode 100644 index 18a3901..0000000 --- a/docs/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -CMM -=== - -.. toctree:: - :maxdepth: 4 - - CMM