/lsdo_function_spaces

A package for creating mathematical functions for parameterization, surrogate modeling, education, and quantity representation

Primary LanguageJupyter NotebookGNU Lesser General Public License v3.0LGPL-3.0

lsdo_function_spaces

GitHub Actions Test Badge Forks Issues

This repository serves as a package for creating functions from various function spaces. The intended purposes include parameterization, creating functional representations of quantities, surrogate modeling, and education. A key aspect of this package is that it is implemented using the Computational System Design Langauge (CSDL), which allows for automatic derivative computation making this a good package for optimization applications or any application where analytic derivative calculation can be helpful.

README.md file contains high-level information about your package: it's purpose, high-level instructions for installation and usage.

Installation

Installation instructions for users

For direct installation with all dependencies, run on the terminal or command line

pip install git+https://github.com/LSDOlab/lsdo_function_spaces.git

If you want users to install a specific branch, run

pip install git+https://github.com/LSDOlab/lsdo_function_spaces.git@branch

Installation instructions for developers

To install lsdo_function_spaces, first clone the repository and install using pip. On the terminal or command line, run

git clone https://github.com/LSDOlab/lsdo_function_spaces.git
pip install -e ./lsdo_function_spaces

For Developers

For details on documentation, refer to the README in docs directory.

For details on testing/pull requests, refer to the README in tests directory.

License

This project is licensed under the terms of the GNU Lesser General Public License v3.0.