Skip to content

Commit 77c9d2b

Browse files
github-actions[bot]github-actions[bot]
authored
Deploy to GitHub pages
0 parents  commit 77c9d2b

445 files changed

Lines changed: 129635 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.buildinfo‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 4293ec76fa402ae2dd7e1489c3174e09
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎.nojekyll‎

Whitespace-only changes.

‎Accretion_disk.html‎

Lines changed: 930 additions & 0 deletions
Large diffs are not rendered by default.

‎Accretion_disk.ipynb‎

Lines changed: 965 additions & 0 deletions
Large diffs are not rendered by default.

‎Emitting_patterns_2Dprojection.html‎

Lines changed: 2156 additions & 0 deletions
Large diffs are not rendered by default.

‎Emitting_patterns_2Dprojection.ipynb‎

Lines changed: 2729 additions & 0 deletions
Large diffs are not rendered by default.

‎Example_job.html‎

Lines changed: 299 additions & 0 deletions
Large diffs are not rendered by default.

‎Example_script_and_modules.html‎

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
2+
3+
<!DOCTYPE html>
4+
<html class="writer-html5" lang="en" data-content_root="./">
5+
<head>
6+
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
7+
8+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9+
<title>Example script and modules &mdash; x-psi 3.3.0 documentation</title>
10+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
11+
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
12+
13+
14+
<script src="_static/jquery.js?v=5d32c60e"></script>
15+
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16+
<script src="_static/documentation_options.js?v=3eb8911e"></script>
17+
<script src="_static/doctools.js?v=fd6eb6e6"></script>
18+
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
19+
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
20+
<script src="_static/js/theme.js"></script>
21+
<link rel="index" title="Index" href="genindex.html" />
22+
<link rel="search" title="Search" href="search.html" />
23+
<link rel="next" title="Example job" href="Example_job.html" />
24+
<link rel="prev" title="Module generator tutorial" href="Module_generator_tutorial.html" />
25+
</head>
26+
27+
<body class="wy-body-for-nav">
28+
<div class="wy-grid-for-nav">
29+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
30+
<div class="wy-side-scroll">
31+
<div class="wy-side-nav-search" >
32+
33+
34+
35+
<a href="index.html" class="icon icon-home">
36+
x-psi
37+
<img src="_static/xpsilogo_small.png" class="logo" alt="Logo"/>
38+
</a>
39+
<div role="search">
40+
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
41+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
42+
<input type="hidden" name="check_keywords" value="yes" />
43+
<input type="hidden" name="area" value="default" />
44+
</form>
45+
</div>
46+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
47+
<p class="caption" role="heading"><span class="caption-text">User Guide</span></p>
48+
<ul>
49+
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
50+
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
51+
<li class="toctree-l1"><a class="reference internal" href="FAQ.html">FAQs and common problems</a></li>
52+
<li class="toctree-l1"><a class="reference internal" href="applications.html">Publications</a></li>
53+
<li class="toctree-l1"><a class="reference internal" href="HPC_systems.html">HPC systems</a></li>
54+
</ul>
55+
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
56+
<ul>
57+
<li class="toctree-l1"><a class="reference internal" href="code_of_conduct.html">Code of Conduct</a></li>
58+
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
59+
<li class="toctree-l1"><a class="reference internal" href="history.html">History</a></li>
60+
<li class="toctree-l1"><a class="reference internal" href="todo.html">Future</a></li>
61+
<li class="toctree-l1"><a class="reference internal" href="acknowledgements.html">Team and acknowledgements</a></li>
62+
<li class="toctree-l1"><a class="reference internal" href="citation.html">Citation</a></li>
63+
</ul>
64+
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
65+
<ul class="current">
66+
<li class="toctree-l1"><a class="reference internal" href="Start_here.html">Start here</a></li>
67+
<li class="toctree-l1"><a class="reference internal" href="XPSI_101.html">X-PSI 101 - For Beginners</a></li>
68+
<li class="toctree-l1"><a class="reference internal" href="Modeling.html">Modeling</a></li>
69+
<li class="toctree-l1"><a class="reference internal" href="Instrument_synergy.html">Instrument synergy</a></li>
70+
<li class="toctree-l1"><a class="reference internal" href="Hot_region_complexity.html">Hot region complexity</a></li>
71+
<li class="toctree-l1"><a class="reference internal" href="Global_surface_emission.html">Global surface emission</a></li>
72+
<li class="toctree-l1"><a class="reference internal" href="Surface_radiation_field_tools.html">Surface radiation field tools</a></li>
73+
<li class="toctree-l1"><a class="reference internal" href="Modeling_without_statistics.html">Modeling (without statistics)</a></li>
74+
<li class="toctree-l1"><a class="reference internal" href="Polarization.html">Polarization</a></li>
75+
<li class="toctree-l1"><a class="reference internal" href="Post-processing.html">Post-processing</a></li>
76+
<li class="toctree-l1"><a class="reference internal" href="Emitting_patterns_2Dprojection.html">Emitting Patterns 2D Projection</a></li>
77+
<li class="toctree-l1"><a class="reference internal" href="Accretion_disk.html">Accretion disk</a></li>
78+
<li class="toctree-l1"><a class="reference internal" href="Other_Emission_Models.html">Other emission models</a></li>
79+
<li class="toctree-l1"><a class="reference internal" href="Other_Emission_Models.html#Emission-models">Emission models</a></li>
80+
<li class="toctree-l1"><a class="reference internal" href="Multiple_imaging.html">Multiple imaging</a></li>
81+
<li class="toctree-l1"><a class="reference internal" href="Importance_sampling.html">Importance Sampling</a></li>
82+
<li class="toctree-l1"><a class="reference internal" href="Synthetic_data.html">Synthetic data</a></li>
83+
<li class="toctree-l1"><a class="reference internal" href="Module_generator_tutorial.html">Module generator tutorial</a></li>
84+
<li class="toctree-l1 current"><a class="current reference internal" href="#">Example script and modules</a></li>
85+
<li class="toctree-l1"><a class="reference internal" href="Example_job.html">Example job</a></li>
86+
<li class="toctree-l1"><a class="reference internal" href="x_p_sbi.html">Posterior Inference using SBI</a></li>
87+
</ul>
88+
<p class="caption" role="heading"><span class="caption-text">API</span></p>
89+
<ul>
90+
<li class="toctree-l1"><a class="reference internal" href="likelihood_api.html">Likelihood API</a></li>
91+
<li class="toctree-l1"><a class="reference internal" href="extension_modules.html">Extension modules</a></li>
92+
<li class="toctree-l1"><a class="reference internal" href="posterior_api.html">Posterior API</a></li>
93+
</ul>
94+
95+
</div>
96+
</div>
97+
</nav>
98+
99+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
100+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
101+
<a href="index.html">x-psi</a>
102+
</nav>
103+
104+
<div class="wy-nav-content">
105+
<div class="rst-content">
106+
<div role="navigation" aria-label="Page navigation">
107+
<ul class="wy-breadcrumbs">
108+
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
109+
<li class="breadcrumb-item active">Example script and modules</li>
110+
<li class="wy-breadcrumbs-aside">
111+
<a href="_sources/Example_script_and_modules.rst.txt" rel="nofollow"> View page source</a>
112+
</li>
113+
</ul>
114+
<hr/>
115+
</div>
116+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
117+
<div itemprop="articleBody">
118+
119+
<section id="example-script-and-modules">
120+
<span id="example-script"></span><h1>Example script and modules<a class="headerlink" href="#example-script-and-modules" title="Link to this heading"></a></h1>
121+
<p>A few example scripts and modules are found here: <a class="reference external" href="https://github.com/xpsi-group/xpsi/tree/main/examples">examples</a>.</p>
122+
<p>The script called <a class="reference external" href="https://github.com/xpsi-group/xpsi/tree/main/examples/examples_fast/Modules/main.py">examples/examples_fast/Modules/main.py</a> is a quick test run not requiring any input files. It assumes a single hot region with a uniform temperature using the default blackbody atmosphere extension and a fake instrument matrix. The same directory also includes <code class="docutils literal notranslate"><span class="pre">main_IS_likelihood.py</span></code> and <code class="docutils literal notranslate"><span class="pre">main_IS_prior.py</span></code> scripts which are needed for the <a class="reference internal" href="Importance_sampling.html"><span class="doc">Importance sampling</span></a> tutorial.</p>
123+
<p>Second script called <a class="reference external" href="https://github.com/xpsi-group/xpsi/tree/main/examples/examples_modeling_tutorial/TestRun_BB.py">examples/examples_modeling_tutorial/TestRun_BB.py</a> is a test run, which is similar to the <a class="reference internal" href="Modeling.html"><span class="doc">Modeling</span></a> tutorial, requiring the same input files as in the corresponding tutorial and using the default blackbody atmosphere extension.</p>
124+
<p>Third script called <a class="reference external" href="https://github.com/xpsi-group/xpsi/tree/main/examples/examples_modeling_tutorial/TestRun_Num.py">examples/examples_modeling_tutorial/TestRun_Num.py</a> is also a test run, which is similar to the <a class="reference internal" href="Modeling.html"><span class="doc">Modeling</span></a> tutorial, except using the numerical atmosphere extension.</p>
125+
<p>Fourth script called <a class="reference external" href="https://github.com/xpsi-group/xpsi/tree/main/examples/examples_modeling_tutorial/TestRun_NumBeam.py">examples/examples_modeling_tutorial/TestRun_NumBeam.py</a> is a similar test run as the previous, except using a numerical atmosphere extension with extra parameters allowing deviations to the atmospheric beaming pattern.</p>
126+
<p>Fifth script called <a class="reference external" href="https://github.com/xpsi-group/xpsi/tree/main/examples/examples_modeling_tutorial/TestRun_Pol.py">examples/examples_modeling_tutorial/TestRun_Pol.py</a> is an example script for producing polarized pulses in X-PSI using a simple analytical model for the atmosphere emission.</p>
127+
<p>Sixth script called <a class="reference external" href="https://github.com/xpsi-group/xpsi/tree/main/examples/examples_modeling_tutorial/TestRun_PolNum_split_1spot.py">examples/examples_modeling_tutorial/TestRun_PolNum_split_1spot.py</a> is an example script for producing polarized pulses in X-PSI using a numerical atmosphere model with 3+2 dimensional interpolation.</p>
128+
<p>Seventh script called <a class="reference external" href="https://github.com/xpsi-group/xpsi/tree/main/examples/examples_modeling_tutorial/TestRun_PolNum_split_inference.py">examples/examples_modeling_tutorial/TestRun_PolNum_split_inference.py</a> is a preliminary example script for producing and analyzing polarized pulses in X-PSI using a numerical atmosphere model with 3+2 dimensional interpolation and ST+PDT spot model.</p>
129+
<p>Eigth script called <a class="reference external" href="https://github.com/xpsi-group/xpsi/tree/main/examples/examples_modeling_tutorial/TestRun_AMXP.py">examples/examples_modeling_tutorial/TestRun_AMXP.py</a> is an example script of an Accreting Millisecond Pulsar with accretion disk implemented through the CustomPhotosphere.py, and 3+2 dimensional interpolation. Note that TestRun_PolNum_split_1spot similarly includes an accretion disk implementation at the end, but there it is a background signal. The results are equivalent but the implementation in this example here is faster and thus recommended for sampling.</p>
130+
</section>
131+
132+
133+
</div>
134+
</div>
135+
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
136+
<a href="Module_generator_tutorial.html" class="btn btn-neutral float-left" title="Module generator tutorial" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
137+
<a href="Example_job.html" class="btn btn-neutral float-right" title="Example job" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
138+
</div>
139+
140+
<hr/>
141+
142+
<div role="contentinfo">
143+
<p>&#169; Copyright 2019-2026 the X-PSI Core Team.</p>
144+
</div>
145+
146+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
147+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
148+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
149+
150+
151+
</footer>
152+
</div>
153+
</div>
154+
</section>
155+
</div>
156+
<script>
157+
jQuery(function () {
158+
SphinxRtdTheme.Navigation.enable(true);
159+
});
160+
</script>
161+
162+
</body>
163+
</html>

0 commit comments

Comments
 (0)