darpanx
DarpanX is a Python 3 package that provides functionality to compute reflectivity and other specular optical functions of a multilayer or single layer mirror for different energy and angles as well as to fit the XRR measurements of the mirrors.
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 7 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.6%) to scientific vocabulary
Repository
DarpanX is a Python 3 package that provides functionality to compute reflectivity and other specular optical functions of a multilayer or single layer mirror for different energy and angles as well as to fit the XRR measurements of the mirrors.
Basic Info
Statistics
- Stars: 8
- Watchers: 5
- Forks: 4
- Open Issues: 0
- Releases: 2
Metadata Files
README.md
DarpanX: A Python Package for Modeling X-ray Reflectivity of Multilayer Mirrors
DarpanX is a Python-3 package that provides functionality to compute reflectivity and other specular optical functions of multilayer/single-layer mirror for different energy and angles as well as to fit the XRR measurements of the mirrors. An API is provided for this and it is also implemented as a local model in PyXspec for fitting the experimental XRR measurements.
For more information regarding the DarpanX see: * Mondal, Biswajit et al. 2021, Astronomy and Computing.
Pre-requisites
Following python modules are required for the installation of darpanx :
setuptools
numpy < 2
scipy
multiprocessing
matplotlib
tabulate
For the experimental data fitting, PyXSPEC (python version of XSPEC) is required.
Installation
The DarpanX package can be downloaded from the Github link- https://github.com/biswajitmb/DarpanX.git
After downloading it, go to the DarpanX directory:
cd DarpanX
To install DarpanX package system-wide:
sudo python3.x setup.py install
Usage
Open a python3.x shell like ipython
import darpanx as drp
import numpy as np
To create a multilayer object
m=drp.Multilayer(MultilayerType="SingleLayer",SubstrateMaterial="SiO2",LayerMaterial=["Pt"],Period=80)
Define the angle and energy values for which the optical functions are to be computed:
Energy=[8.0] # Incident beam energy in KeV
Theta=np.arange(start=0,stop=5,step=0.01) #Define Grazing angles in degree.
Compute reflectivity
m.get_optical_func(Theta=Theta,Energy=Energy,AllOpticalFun ="yes")
Plot outputs:
m.plot(ylog="no", Comp=["Ra","Ta","Aa"], AllComp="oplot", Scale="yes")
All available functionality with examples are described in the DarpanX_UserManual.pdf
Use of DarpanX should be acknowledged by referencing the paper: Mondal, B. et al. 2021, Astronomy and Computing.
Owner
- Name: X-ray Astronomy Lab @ PRL
- Login: xastprl
- Kind: organization
- Repositories: 2
- Profile: https://github.com/xastprl
X-ray astronomy and instrumentation group at Physical Research Laboratory, Ahmedabad, India
Citation (CITATION.cff)
cff-version: 1.2.0
message: "Use of DarpanX should be acknowledged by citing the paper. Please use the 'Cite this repository' dropdown to get a citation in a desirable format."
authors:
- family-names: "Mondal"
given-names: "Biswajit"
orcid: "https://orcid.org/0000-0002-7020-2826"
- family-names: "Vadawale"
given-names: "Santosh V."
- family-names: "Mithun"
given-names: "N.P.S."
orcid: "https://orcid.org/0000-0003-3431-6110"
- family-names: "Vaishnava"
given-names: "C. S."
- family-names: "Tiwari"
given-names: "Neeraj .K."
- family-names: "Goyal"
given-names: "Shiv Kumar"
- family-names: "Panini"
given-names: "Singam S."
orcid: "https://orcid.org/0000-0002-6682-4841"
- family-names: "Navalkar"
given-names: "Vinita"
orcid: "https://orcid.org/0000-0003-2314-2098"
- family-names: "Karmakar"
given-names: "Chiranjit"
orcid: "https://orcid.org/0000-0003-0622-7487"
- family-names: "Patel"
given-names: "Mansukhlal R."
- family-names: "Upadhyay"
given-names: "R. B."
title: "DarpanX: X-ray reflectivity of multilayer mirrors"
version: 0.4
doi: "10.5281/zenodo.7220885"
date-released: 2020-12-12
url: "https://github.com/xastprl/DarpanX"
preferred-citation:
type: article
authors:
- family-names: "Mondal"
given-names: "Biswajit"
orcid: "https://orcid.org/0000-0002-7020-2826"
- family-names: "Vadawale"
given-names: "Santosh V."
- family-names: "Mithun"
given-names: "N.P.S."
orcid: "https://orcid.org/0000-0003-3431-6110"
- family-names: "Vaishnava"
given-names: "C. S."
- family-names: "Tiwari"
given-names: "Neeraj .K."
- family-names: "Goyal"
given-names: "Shiv Kumar"
- family-names: "Panini"
given-names: "Singam S."
orcid: "https://orcid.org/0000-0002-6682-4841"
- family-names: "Navalkar"
given-names: "Vinita"
orcid: "https://orcid.org/0000-0003-2314-2098"
- family-names: "Karmakar"
given-names: "Chiranjit"
orcid: "https://orcid.org/0000-0003-0622-7487"
- family-names: "Patel"
given-names: "Mansukhlal R."
- family-names: "Upadhyay"
given-names: "R. B."
doi: "10.1016/j.ascom.2020.100446"
journal: "Astronomy and Computing"
month: 1
start: 100446
title: "DarpanX: A python package for modeling X-ray reflectivity of multilayer mirrors"
volume: 34
year: 2021
GitHub Events
Total
- Issues event: 1
- Watch event: 1
- Push event: 2
Last Year
- Issues event: 1
- Watch event: 1
- Push event: 2