xmipp3-installer

Python package that handles the installation of xmipp3.

Installation

To install the package, simply run:

pip install xmipp3-installer

Usage

This package has a CLI built-in, with help messages that explain how to use it. To run such help, once the package is installed, run:

xmipp3_installer -h

Installation telemetry

This installer collects basic information about your installation environment (such as library versions, system architecture, and operating system) to improve compatibility, performance, and stability.

If you prefer not to send this data, you can disable data collection by simply setting the environment variable XMIPP3_SEND_INSTALLATION_STATISTICS=OFF before running the installation command.

For more information, please visit the documentation.

Testing the code

In order to run the tests for this project, the project needs to be installed in development mode and also the test dependencies need to be installed.

To do that, you need to clone this project, move inside the repository's folder, and run:

pip install -e .[test]

Once the dependencies have been installed, the automatic tests for this package can be run using ./scripts/run-tests.sh in bash, or .\scripts\run-tests.ps1 in PowerShell. If you intend to run this tests from within VSCode, you will need extension Test Adapter Converter, and a local .vscode folder with a file named settings.json inside with the following content:

{
  "python.testing.pytestArgs": [
    ".",
    "--capture=no"
  ],
  "python.testing.unittestEnabled": false,
  "python.testing.pytestEnabled": true
}

SonarQube status

Ratings

Specific metrics