Installation Guide
System Requirements
Before installing Femora, ensure your system meets the following requirements:
Operating System: Windows, macOS, or Linux
Python: Version 3.8 or higher
Disk Space: Approximately 100 MB
Dependencies: NumPy, SciPy, Matplotlib, PySide6
Installation Methods
There are several ways to install Femora:
Using pip
The easiest way to install Femora is using pip:
pip install femora
From Source
To install from source:
Clone the repository:
git clone https://github.com/yourusername/Femora.git cd Femora
Install the package:
pip install -e .
Using Conda
Femora can also be installed using conda:
conda env create -f environment.yml
conda activate Femora
Verifying Installation
To verify that Femora has been installed correctly, run:
import femora
print(femora.__version__)
This should display the version number of your Femora installation.
Dependencies
Femora depends on several Python packages:
NumPy: For numerical operations
SciPy: For scientific computing
Matplotlib: For visualization
PySide6: For GUI components
OpenSees: For structural analysis (optional)
Troubleshooting
Common Installation Issues
Missing Dependencies:
If you encounter errors related to missing dependencies, try:
pip install -r requirements.txt
Version Conflicts:
If you have version conflicts with existing packages, try creating a virtual environment:
python -m venv Femora_env source Femora_env/bin/activate # On Windows: Femora_env\Scripts\activate pip install femora
Permission Errors:
If you encounter permission errors, try:
pip install --user femora
Getting Help
If you continue to experience installation issues, please:
Check the GitHub issues page for similar problems and solutions
Contact the support team at support@femora.org
Join our community forum at https://community.femora.org