current-density-deconvolution
Science Score: 44.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
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (9.8%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: rhmatti
- License: gpl-3.0
- Language: Python
- Default Branch: main
- Size: 186 KB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 1
Metadata Files
README.md
Current Density Deconvolution
Installation Instructions
To run, users must have python version 3.9 or newer installed on their machine.
In addition to the base install of python, the following packages are required:
a. Numpy
python -m pip install numpyb. Matplotlib
python -m pip install matplotlibc. Scipy
python -m pip install scipyDownload the code as a .zip file, and extract all contents to the desired directory
User Instructions
Open the file
Deconvolution Script.pyin your editor of choiceDefine your input parameters:
a. Variable
dataFile:- This is the data file containing the measured current profile of the beam
- This data file must be formatted as a 2D matrix of evenly spaced current samples
- The first line of the file contains the dimensions of the matrix
- Rows correspond to y-deflection position, and columns correspond to x-deflection position
- Numbers correspond to the measured current at that x-y position
- See
sample_data.txtfor an example of a properly formatted data file
- Enter the filename (if in the same directory) or full filepath (if in a different directory)
b. Variable
dec.Rsample: * This is the "sample radius" (i.e. half of the width of the data matrix) * This is a distance and should be entered in units of mm * This is half of the total distance the beam was deflected along its longest axisc. Variable
dec.spacing: * This is the physical spacing between the data points indataFilein units of mmd. Variable
dec.R: * This is the radius of the detector aperture (for circular aperture detectors) in units of mmRun the script
Note: The file
Deconvolution Script.pyhas the variables preconfigured to run a deconvolution immediately with the included sample data and detector files
Owner
- Name: Richard Mattish
- Login: rhmatti
- Kind: user
- Company: Clemson University
- Repositories: 3
- Profile: https://github.com/rhmatti
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "Mattish" given-names: "Richard" orcid: "https://orcid.org/0000-0001-8083-6892" title: "Deconvolution of Measured Current Profiles" version: 1.0.0 doi: 10.5281/zenodo.1234 date-released: 2022-07-12 url: "https://github.com/rhmatti/Current-Density-Deconvolution"