semvec/pypi-packages huggingface dataset:
numlpa 1.0.0b9
Numerical Line Profile Analysis package.
Requires Python: <3.12,>=3.8

# ![NumLPA](docs/source/logo.svg)

What does it mean?

> The name "NumLPA" comes from the contraction of "Numerical Line Profile Analysis".

What is the use of it?

> NumLPA is a Python package developed for research in materials science.

Is it hard to use?

> Just type one of the available commands in a terminal and look at the generated files.

## Background

The physical properties of a solid material are strongly impacted by the nature and quantity of structural defects it contains.
It is therefore important to have reliable tools to characterize deviations from a perfect crystal.
Line Profile Analysis (LPA) is one of the methods used for the study of microstructures from the analysis of X-ray diffraction patterns.

## Features

NumLPA Has been developed to meet the need to analyze the accuracy of LPA models.
The main features of the package are presented bellow:

* `draw`: Generate samples of dislocations by random drawing from different probability distribution models.
* `diffract`: Simulate X-ray diffraction on crystals containing the previously generated dislocations and compute the Fourier transform of the diffracted intensity.
* `merge`: Average the Fourier transform coefficients or the strain energy evaluations from multiple samples drawn from a same distribution.
* `fit`: Fit LPA models on the simulated diffraction profiles to obtain their predictions and compare them to the real parameters of the distribution.
* `evaluate`: Compute the strain energy density and the outer cut-off radius for a sample of dislocations.
* `analyze`: Perform a spatial statistical analysis and calculate the strain energy contained in a sample of dislocations.
* `export`: Export figures illustrating the previously generated data according to different representations.

## Installation

You can find how to install the package in the [installation section](https://x-rays.gitlab.io/numlpa/practice/installation/index.html) of the documentation.

## Usage

You can find how to use the package in the [examples section](https://x-rays.gitlab.io/numlpa/practice/examples/index.html) of the documentation.

## Credits

* Dunstan Becht
* Asdin Aoufi
* András Borbély

## License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
jk_terminal_essentials 0.2024.2.2
This module provides essential constants and information about the terminal. This module is intended for implementing CLI tools and other applications running in a terminal.
Requires Python: >=3.8
Keywords: console,terminal,colors

jk_terminal_essentials
==========

Introduction
------------

This module provides essential constants and information about the terminal. This module is intended for implementing CLI tools and other applications running in a terminal.

Information about this module can be found here:

* [github.org](https://github.com/jkpubsrc/....)
* [pypi.python.org](https://pypi.python.org/pypi/jk_terminal_essentials)

How to use this module
----------------------

### Import this module

Please include this module into your application using the following code:

```python
import jk_terminal_essentials as te
```

### Colors

This module provides a variety of color constants. For example:

```python
print(te.FGCOLOR_RED + "Error!" + te.STYLE_RESET)
```

The following colors are supported:

```python
FGCOLOR_BLACK = "\x1b[30m"
FGCOLOR_RED = "\x1b[31m"
FGCOLOR_GREEN = "\x1b[32m"
FGCOLOR_YELLOW = "\x1b[33m"
FGCOLOR_BLUE = "\x1b[34m"
FGCOLOR_MAGENTA = "\x1b[35m"
FGCOLOR_CYAN = "\x1b[36m"
FGCOLOR_LIGHT_GRAY = "\x1b[37m"

FGCOLOR_DARK_GRAY = "\x1b[90m"
FGCOLOR_LIGHT_RED = "\x1b[91m"
FGCOLOR_LIGHT_GREEN = "\x1b[92m"
FGCOLOR_LIGHT_YELLOW = "\x1b[93m"
FGCOLOR_LIGHT_BLUE = "\x1b[94m"
FGCOLOR_LIGHT_MAGENTA = "\x1b[95m"
FGCOLOR_LIGHT_CYAN = "\x1b[96m"
FGCOLOR_WHITE = "\x1b[97m"

BGCOLOR_BLACK = "\x1b[40m"
BGCOLOR_RED = "\x1b[41m"
BGCOLOR_GREEN = "\x1b[42m"
BGCOLOR_YELLOW = "\x1b[43m"
BGCOLOR_BLUE = "\x1b[44m"
BGCOLOR_MAGENTA = "\x1b[45m"
BGCOLOR_CYAN = "\x1b[46m"
BGCOLOR_LIGHT_GRAY = "\x1b[47m"

BGCOLOR_DARK_GRAY = "\x1b[100m"
BGCOLOR_LIGHT_RED = "\x1b[101m"
BGCOLOR_LIGHT_GREEN = "\x1b[102m"
BGCOLOR_LIGHT_YELLOW = "\x1b[103m"
BGCOLOR_LIGHT_BLUE = "\x1b[104m"
BGCOLOR_LIGHT_MAGENTA = "\x1b[105m"
BGCOLOR_LIGHT_CYAN = "\x1b[106m"
BGCOLOR_WHITE = "\x1b[107m"
```

### Check for Color Support

To check if the current terminal supports colors:

```python
print(te.checkTerminalSupportsColors())
```

Author(s)
-------------------

* Jürgen Knauth: pubsrc@binary-overflow.de

License
-------

This software is provided under the following license:

* Apache Software License 2.0