Install

For the majority of users, this package can be easily installed from Python wheels using either pip or conda. More information on installation can be found in the Install from Wheels or Install in Virtual Environment sections.

Additionally, you can explore the Runtime Dependencies section to install any required or optional runtime dependencies that might be necessary based on your specific requirements.

For more advanced usage, there may be cases where you need to compile the package from its source code. Resources and instructions for compiling from source can be found in the Compile from Source and Generate Documentation sections. Instructions for testing the package are available in the Test Package section.

• 1. Install from Wheels
  • 1.1. Install with pip
  • 1.2. Install with conda
• 2. Install in Virtual Environment
  • 2.1. Install in virtualenv Environment
  • 2.2. Install in conda Environment
• 3. Runtime Dependencies
  • 3.1. OpenMP (Required)
  • 3.2. Perf Tool (Optional)
• 4. Compile from Source
  • 4.1. When to Compile detkit
  • 4.2. Install C++ Compiler (Required)
  • 4.3. Install OpenMP (Required)
  • 4.4. Configure Compile-Time Environment Variables (Optional)
  • 4.5. Compile and Install
• 5. Generate Documentation
  • 5.1. Compile Package
  • 5.2. Generate Sphinx Documentation
• 6. Test Package
  • 6.1. Test with pytest
  • 6.2. Test with tox
• 7. Troubleshooting
  • 7.1. Cannot load libomp
  • 7.2. Issue of Initializing libomp