scnc
/
Dioptas
mirror of https://github.com/Dioptas/Dioptas.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
5,896 Commits 5 Branches 29 Tags 304 MiB
Python 93.5%
Makefile 4.7%
CSS 1.7%
Go to file
Clemens Prescher e6f858b226 CD: remove unnecessary pyFAI executables 2024-07-21 16:29:22 +02:00
.github/workflows BUILD: update upload artifact version to 4 2024-05-10 09:00:25 +02:00
conda_scripts remove remainders of python2 compatibility 2023-12-15 19:06:38 +01:00
dioptas Bump version to 0.6.1 2024-06-18 17:56:20 +02:00
docs Updated the Copyright Information in all files 2019-02-20 06:08:37 +01:00
scripts use Github artifacts for all CD, disable dropbox 2023-09-28 11:32:13 +02:00
.gitattributes setuptools initialization 2016-08-23 10:09:55 +02:00
.gitignore add __pycache__ to gitignore 2024-01-05 20:39:01 +01:00
Dioptas.spec CD: remove unnecessary pyFAI executables 2024-07-21 16:29:22 +02:00
LICENSE.txt rename license.txt -> LICENSE.txt 2023-12-07 12:57:39 +01:00
MANIFEST.in Removed large files form PyPi package by specifying them in MANIFEST.in 2022-11-23 17:11:10 +01:00
README.md Add info for MacOS X executables in readme 2024-06-18 17:56:36 +02:00
changelog.md Add recent changes to changelog 2024-06-18 17:53:06 +02:00
create_executable.bat Finish the windows build script 2020-04-24 20:06:16 +02:00
create_executable.sh updated all executable creation files to also work on macOS 2017-07-26 10:56:05 +02:00
example_config.json FEATURE: added external actions 2024-02-26 13:49:23 +01:00
poetry.lock update dependencies to latest (poetry update) 2024-05-14 14:31:51 +02:00
pyproject.toml Bump version to 0.6.1 2024-06-18 17:56:20 +02:00
run.py updated readme and added a run.py file 2023-06-30 18:46:18 +02:00

README.md

Dioptas

A GUI program for fast analysis of powder X-ray diffraction Images. It provides the capability of calibrating, creating masks, having pattern overlays and showing phase lines.

Maintainer

Clemens Prescher (clemens.prescher@gmail.com)

Requirements

* python 3.9+

It is known to run on Windows, Mac and Linux. For optimal usage on a Windows machine it should be run with 64 bit python. When used with 32 bit Dioptas occasionally crashes because of limited memory allocation possibilities.

Installation

Executables

Executable versions for Windows, Mac OsX and Linux (all 64bit) can be downloaded from:

https://github.com/Dioptas/Dioptas/releases

The executable versions are self-contained folders, which do not need any python installation. Under Windows and Linux the program can be started by running the executable (e.g. Dioptas.exe or Dioptas). Under MacOS X the folder will contain an app folder which can be double-clicked for starting. Please accept the security prompts.

Unfortunately, I am currently unable to create working App for MacOS X. Users of this convoluted operation system need to install dioptas using "pip" and then start it from the commandline. (see below)

Code

In order to make changes to the source code yourself or always get the latest development versions you need to install the required python packages on your machine.

The easiest way to install the all the dependencies for Dioptas is to use the pip package manager:

pip install dioptas

and then run Dioptas by typing:

dioptas

in the commandline.

Running the Program from source

The easiest way to create a working environment for Dioptas is to use the poetry package manager. A new environment is created by running:

poetry install

This will create a new environment with all the required packages. The environment can be activated by running:

poetry shell

Afterward the program can be started by running:

dioptas

In order to run the program without activating the environment, the program can be started by running:

poetry run dioptas

In case you want to run the Dioptas from source without poetry, you need to install the required packages yourself. The packages are listed in the file pyproject.toml. The program can then be started by running:

python run.py