Skip to content

Commit 0b4dabb

Browse files
mverpellimverpelli
committed
new baseline
0 parents  commit 0b4dabb

File tree

325 files changed

+337613
-0
lines changed

Some content is hidden

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

325 files changed

+337613
-0
lines changed

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 IAEA Nuclear Data Section
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# NDLab - Beta testing
2+
3+
NDlab is a package for nuclear (mainly)structure data analysis, calculation, and modelling.
4+
5+
**It comprises**
6+
7+
* an engine to retrive data and plug them into data manipulation tools like pandas and plotly
8+
* a set of Python classes and functions to write custom code
9+
10+
**Its main features are**
11+
12+
* intuitive way to interrogate the database
13+
* smooth connection to Python data analysis and plotting packages
14+
* customizable Pyhton modules to write algorithms and simulations
15+
* automatic propagation of uncertainties when performing calculations
16+
* option to directly access the underlying SQL database
17+
18+
19+
## **How to install it**
20+
21+
* download the code or the last release
22+
* go intoto /ndlab and unzip the database ndlab_db.s3db.zip
23+
* install the <a href="https://pythonhosted.org/uncertainties/">uncertainties</a> package
24+
25+
.
26+
27+
$ pyp install uncertainties
28+
29+
**Quick intro**
30+
31+
* have a look at the [**ndlab-tutorial.html**](https://IAEA-NDS.github.io/ndlab/_static/ndlab-tutorial.html "html")
32+
* run the Notebook ndlab-tutorial.ipynb
33+
34+
Access [**the documentation**](https://IAEA-NDS.github.io/ndlab/ "docs") for further details.
35+
36+
37+
# Contributing
38+
39+
If you have made an addition to this package and would like to contribute it to this project, you may consider performing a pull request. By effecting a pull request, you accept that the copyright of your contribution, which is the code or other information added to this repository, is transferred to the IAEA. This ensures that we can change the license in the future if required. We stress that if such a change of license should ever happen, you can nevertheless continue to use any version before the switch of license according to the applicable license at that time.
40+
41+
# Legal note
42+
43+
This code is distributed under the MIT license
44+
45+
Copyright (c) International Atomic Energy Agency (IAEA)

‎docs/.nojekyll

Whitespace-only changes.

‎docs/_images/ndlab.png

48.4 KB
Loading

‎docs/_modules/index.html

Lines changed: 247 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,247 @@
1+
2+
3+
<!DOCTYPE html>
4+
<html class="writer-html5" lang="en" >
5+
<head>
6+
<meta charset="utf-8" />
7+
8+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9+
10+
<title>Overview: module code &mdash; NDLab 0.1 documentation</title>
11+
12+
13+
14+
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
15+
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
16+
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
17+
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
18+
<link rel="stylesheet" href="../_static/css/ndlab.css" type="text/css" />
19+
20+
21+
22+
<link rel="shortcut icon" href="../_static/favicon.ico"/>
23+
24+
25+
26+
27+
28+
29+
30+
31+
<!--[if lt IE 9]>
32+
<script src="../_static/js/html5shiv.min.js"></script>
33+
<![endif]-->
34+
35+
36+
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
37+
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
38+
<script src="../_static/jquery.js"></script>
39+
<script src="../_static/underscore.js"></script>
40+
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
41+
<script src="../_static/doctools.js"></script>
42+
43+
<script type="text/javascript" src="../_static/js/theme.js"></script>
44+
45+
46+
<link rel="index" title="Index" href="../genindex.html" />
47+
<link rel="search" title="Search" href="../search.html" />
48+
</head>
49+
50+
<body class="wy-body-for-nav">
51+
52+
53+
<div class="wy-grid-for-nav">
54+
55+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
56+
<div class="wy-side-scroll">
57+
<div class="wy-side-nav-search" >
58+
59+
60+
61+
<a href="../index.html">
62+
63+
64+
65+
66+
<img src="../_static/ndlab.png" class="logo" alt="Logo"/>
67+
68+
</a>
69+
70+
71+
72+
73+
<div role="search">
74+
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
75+
<input type="text" name="q" placeholder="Search docs" />
76+
<input type="hidden" name="check_keywords" value="yes" />
77+
<input type="hidden" name="area" value="default" />
78+
</form>
79+
</div>
80+
81+
82+
</div>
83+
84+
85+
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
86+
87+
88+
89+
90+
91+
92+
<p class="caption" role="heading"><span class="caption-text">Installation</span></p>
93+
<ul>
94+
<li class="toctree-l1"><a class="reference internal" href="../installation.html">1. Get NDLab</a></li>
95+
<li class="toctree-l1"><a class="reference internal" href="../installation.html#dependencies">2. Dependencies</a></li>
96+
<li class="toctree-l1"><a class="reference internal" href="../installation.html#test-it-s-working">3. Test it’s working</a></li>
97+
<li class="toctree-l1"><a class="reference internal" href="../installation.html#optional-packages">4. Optional packages</a></li>
98+
</ul>
99+
<p class="caption" role="heading"><span class="caption-text">Interrogation</span></p>
100+
<ul>
101+
<li class="toctree-l1"><a class="reference internal" href="../interrogation.html">0. Cheat sheet</a></li>
102+
<li class="toctree-l1"><a class="reference internal" href="../interrogation.html#retrieval-functions">1. Retrieval functions</a></li>
103+
<li class="toctree-l1"><a class="reference internal" href="../interrogation.html#the-fields-parameter">2. The fields parameter</a></li>
104+
<li class="toctree-l1"><a class="reference internal" href="../interrogation.html#the-filter-parameter">3. The filter parameter</a></li>
105+
<li class="toctree-l1"><a class="reference internal" href="../interrogation.html#examples">4. Examples</a></li>
106+
<li class="toctree-l1"><a class="reference internal" href="../interrogation.html#j-p-values">5. J <sup>p</sup> values</a></li>
107+
<li class="toctree-l1"><a class="reference internal" href="../interrogation.html#decay-modes">6. Decay modes</a></li>
108+
<li class="toctree-l1"><a class="reference internal" href="../interrogation.html#three-lines-of-code">7. Three lines of code</a></li>
109+
<li class="toctree-l1"><a class="reference internal" href="../interrogation.html#sql-through-python">8. SQL through Python</a></li>
110+
<li class="toctree-l1"><a class="reference internal" href="../interrogation.html#sql-direct-connection">9. SQL direct connection</a></li>
111+
</ul>
112+
<p class="caption" role="heading"><span class="caption-text">Programming</span></p>
113+
<ul>
114+
<li class="toctree-l1"><a class="reference internal" href="../programming.html">0. Cheat sheet</a></li>
115+
<li class="toctree-l1"><a class="reference internal" href="../programming.html#programming-overview">1. Programming overview</a></li>
116+
<li class="toctree-l1"><a class="reference internal" href="../programming.html#classes-and-functions">2. Classes and functions</a></li>
117+
<li class="toctree-l1"><a class="reference internal" href="../programming.html#pandas">3. Pandas</a></li>
118+
<li class="toctree-l1"><a class="reference internal" href="../programming.html#work-with-measurements">3. Work with Measurements</a></li>
119+
</ul>
120+
<p class="caption" role="heading"><span class="caption-text">Constructing &quot;fields&quot; and &quot;filter&quot;</span></p>
121+
<ul>
122+
<li class="toctree-l1"><a class="reference internal" href="../entities.html">1. Legend</a></li>
123+
<li class="toctree-l1"><a class="reference internal" href="../entities.html#entities">2. Entities</a></li>
124+
<li class="toctree-l1"><a class="reference internal" href="../entities.html#constants">3. Constants</a></li>
125+
</ul>
126+
<p class="caption" role="heading"><span class="caption-text">Code Documentation</span></p>
127+
<ul>
128+
<li class="toctree-l1"><a class="reference internal" href="../code.html">1. ndlab module</a></li>
129+
<li class="toctree-l1"><a class="reference internal" href="../code.html#ndlaborm-module">2. ndlaborm module</a></li>
130+
<li class="toctree-l1"><a class="reference internal" href="../code.html#ndlabdblink-module">3. ndlabdblink module</a></li>
131+
</ul>
132+
<p class="caption" role="heading"><span class="caption-text">The Database</span></p>
133+
<ul>
134+
<li class="toctree-l1"><a class="reference internal" href="../database.html">1. The search engine</a></li>
135+
<li class="toctree-l1"><a class="reference internal" href="../database.html#underlying-databases">2. Underlying databases</a></li>
136+
<li class="toctree-l1"><a class="reference internal" href="../database.html#data-sources">3. Data sources</a></li>
137+
</ul>
138+
139+
140+
141+
</div>
142+
143+
</div>
144+
</nav>
145+
146+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
147+
148+
149+
<nav class="wy-nav-top" aria-label="top navigation">
150+
151+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
152+
<a href="../index.html">NDLab</a>
153+
154+
</nav>
155+
156+
157+
<div class="wy-nav-content">
158+
159+
<div class="rst-content">
160+
161+
162+
163+
164+
165+
166+
167+
168+
169+
170+
171+
172+
173+
174+
175+
176+
177+
178+
179+
<div role="navigation" aria-label="breadcrumbs navigation">
180+
181+
<ul class="wy-breadcrumbs">
182+
183+
<li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
184+
185+
<li>Overview: module code</li>
186+
187+
188+
<li class="wy-breadcrumbs-aside">
189+
190+
</li>
191+
192+
</ul>
193+
194+
195+
<hr/>
196+
</div>
197+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
198+
<div itemprop="articleBody">
199+
200+
<h1>All modules for which code is available</h1>
201+
<ul><li><a href="ndlab.html">ndlab</a></li>
202+
</ul>
203+
204+
</div>
205+
206+
</div>
207+
<footer>
208+
209+
<hr/>
210+
211+
<div role="contentinfo">
212+
<p>
213+
&#169; Copyright 2022, IAEA Nuclear Data Section.
214+
215+
</p>
216+
</div>
217+
218+
219+
220+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
221+
222+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
223+
224+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
225+
226+
</footer>
227+
</div>
228+
</div>
229+
230+
</section>
231+
232+
</div>
233+
234+
235+
<script type="text/javascript">
236+
jQuery(function () {
237+
SphinxRtdTheme.Navigation.enable(true);
238+
});
239+
</script>
240+
241+
242+
243+
244+
245+
246+
</body>
247+
</html>

0 commit comments

Comments
 (0)