-
Notifications
You must be signed in to change notification settings - Fork 57
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
34 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,61 +1,68 @@ | ||
This is the MIT version of the PyMca XRF Toolkit. | ||
Please read the LICENSE file to know what that means. | ||
Please read the LICENSE file for details. | ||
|
||
INSTALLATION | ||
|
||
I remind you that ready-to-use packages are available for the most | ||
common platforms. Please keep going if you want to build the code from | ||
source. | ||
Ready-to-use packages are available for the most common platforms. | ||
|
||
If you want to build from a github checkout, you will need cython installed | ||
on your system. If you use a source distribution, the generated code should | ||
be already there. | ||
PyMca frozen binaries for MacOS and windows can be obtained from sourceforge: | ||
|
||
Examples of use: | ||
https://sourceforge.net/projects/pymca/files/pymca/ | ||
|
||
1 - Install everything in default directories (typical for windows users or system | ||
administrators): | ||
Unofficial debian packages are also available, but you should check if official pacakges are available for your distribution. | ||
|
||
python setup.py install | ||
Please keep going if you want to use PyMca with your existing Python installation. | ||
|
||
The simplest solution is to use pip: | ||
|
||
pip install PyMca5 | ||
|
||
2 - Install to specific destinations (typical for posix systems): | ||
You can add the usual --user qulifier to install only for you: | ||
|
||
python setup.py install --install-scripts SCRIPTS_DIRECTORY | ||
python setup.py install --install-lib DESTINATION_DIRECTORY | ||
python setup.py install --install-lib DESTINATION_DIRECTORY --install-scripts SCRIPTS_DIRECTORY | ||
pip install PyMca5 --user | ||
|
||
The directories have to be specified with their full path without the last "/". | ||
If you want to build from source distribution or from a github checkout, you may want to have | ||
cython installed on your system. | ||
|
||
In any case you need write privileges to the final directories. | ||
Examples of installation from the sources. | ||
|
||
1 - In your default python installation: | ||
|
||
python setup.py install | ||
|
||
3 - Creation of an easy to install windows binary using Visual Studio | ||
or (better) | ||
|
||
python setup.py bdist_wininst --install-script pymca_win_post_install.py | ||
pip install . | ||
|
||
4 - Creation of an easy to install windows binary using the MinGW compiler | ||
python setup.py build -c mingw32 | ||
python setup.py bdist_wininst --skip-build --install-script pymca_win_post_install.py | ||
2 - In your user account: | ||
|
||
python setup.py install --user | ||
|
||
or | ||
|
||
pip install | ||
|
||
You will need: | ||
|
||
- Python (> 2.6 recommended) | ||
- Python (one of 2.7 or 3.5 recommended) | ||
|
||
- Numpy | ||
|
||
- fisx | ||
|
||
If you want to use the graphical interfaces provided, you will need a running | ||
python installation with: | ||
python installation with one of: | ||
|
||
- PyQt4 + matplotlib (PyMca license will be GPL unless you have a commercial PyQt4 license) | ||
- PyQt5 + matplotlib (PyMca license will be GPL unless you have a commercial PyQt5 license) | ||
- PySide + matplotlib (PyMca license will be MIT because PySide is LGPL) | ||
|
||
If you want to embed PyMca in your own graphical applications, I recommend you to use | ||
the McaAdvancedFit.py module. It is very easy to embed. | ||
|
||
DEVELOPMENT PLANS | ||
|
||
- Port all Physics to C++ | ||
|
||
- Include analytical secondary excitation corrections in multilayers. | ||
- Use the fisx library for all Physics calculations and not just for corrections. | ||
|
||
- Compound fitting. | ||
|
||
|
@@ -65,4 +72,3 @@ contact me. | |
Enjoy, | ||
|
||
V. Armando Sole | ||
[email protected] |