Clean Numerical Simulation with Python (cnspy)

Clean Numerical Simulation code generater using Python.

---

📥 Clone or Download

Clone the Repository

git clone https://github.com/Zilpher/cnspy.git
cd cnspy

Or Download as a ZIP

1. Click the Code button on the repository page.
2. Select Download ZIP.
3. Extract the contents to your desired location.

---

🛠️ Setup Instructions

System Requirements

Ensure the following dependencies are installed with the minimum versions:

• GCC: 4.8.5 or higher
• OpenMPI: 2.1.0 or higher
• GMP: 6.1.0 or higher
• MPFR: 4.2.0 or higher

1. Create and Activate a Virtual Environment

conda create -n <envname>  # Replace <envname> with your environment name
conda activate <envname>

2. Install Required Packages

conda install numpy sympy scipy paramiko setuptools ipykernel

3. Build and Install cnspy

python setup.py bdist_wheel
pip install dist/cnspy-1.0-py3-none-any.whl

4. Uninstall cnspy

To remove the package, use:

pip uninstall cnspy

5. Reinstall cnspy

To reinstall or update the package, use:

pip install dist/cnspy-1.0-py3-none-any.whl --force-reinstall

6. Run an Example

1. Navigate to the example folder.
2. Open a *.ipynb file using Jupyter Notebook.
3. Run the notebook to test the functionality.

---

📚 Documentation and Examples

For detailed documentation and additional examples, please refer to the documentation page.

📝 License

This project is licensed under the MPL-2.0 license. See the LICENSE file for details.

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page or submit a pull request.

---

Happy using with cnspy! 🚀