Commit 60b1c90e authored by Julia Garriga Ferrer's avatar Julia Garriga Ferrer
Browse files

Modified README and setup

parent 744d49e4
Pipeline #15743 passed with stage
in 2 minutes and 33 seconds
darfix
=========
The purpose of this API is to create a set of functions and classes to help the beamline 06 read a series of data images and apply the operations needed for the experiments.
Darfix is a Python library to provide the id06 at the ESRF a series of computer vision techniques, together with a graphical user interface and an Orange3(https://github.com/biolab/orange3) add-on to define the workflow.
Installation
------------
To install it simply run
To install the last release run
.. code-block:: bash
pip install darfix
To install from sources:
.. code-block:: bash
git clone https://gitlab.esrf.fr/julia.garriga/darfix.git
cd darfix
pip install -r requirements.txt
pip install .
To test the orange workflow (only from sources) just run
.. code-block:: bash
orange-canvas orangecontrib/tutorials/example_tutorial.ows
\ No newline at end of file
......@@ -409,7 +409,7 @@ def get_project_configuration(dry_run):
author="data analysis unit",
author_email="julia.garriga@esrf.fr",
classifiers=classifiers,
description="Project for the interpretation of data in id06",
description="Computer vision software for the interpretation of diffracted images",
long_description=get_readme(),
namespace_packages=NAMESPACE_PACKAGES,
packages=PACKAGES,
......@@ -419,6 +419,8 @@ def get_project_configuration(dry_run):
package_data=package_data,
zip_safe=False,
entry_points=entry_points,
license='MIT License',
platforms='linux',
)
return setup_kwargs
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment