A Python package with models from structural design codes.
🚧 Note! This package is work in progress. Feel free to join the discussions in the pull requests. 🚧
The package is still on a premature level. As soon as we start tagging versions, the package will be pip-installable from source. Eventually, the package will be published on PyPI.
The package will be based on a hierachical structure. On the lowest level, models from different structural design codes are implemented in sub-packages. The work is coordinated by the fib, and the fib Model Code and Eurocode 2 are used as cases for establishing the structure.
On the higher levels there will be material, cross section and element classes related to specific design codes, e.g. ConcreteMC2010 and RCRectangularMC2010.
For the moment, the core team has completed an initial structure for the two lowest levels, i.e. how to structure the models from the structural design codes, and how to create classes that represent materials. Contributions that seek to add content to the lowest level are highly appreciated ❤️
We have defined a set of milestones that indicate our priorities. Issues are linked to each milesstone, and some of the issues include a to-do list and have linked pull requests. Contributions related to the milestones are highly appreciated. For the moment, our first priority is to add code related to fib Model Code 2020, but other contributions are of course also welcome!
Here is how to get started.
First:
- Take a look at the milestones, find one that suits your interests, and navigate to a related issue. Create a comment in the issue indicating the topic that you wish to contribute. Make sure that the topic is not already started by someone else.
- If you didn't find a suitable milestone or issue, please create a new issue where you describe your request or feature idea. Make sure that you get a GO from the core team before continuing your contribution. We promise to provide feedback as soon as we can.
Then:
- Create a fork of the repo.
- Set up your local development environment, see below
⤵️ . - Start developing the feature in a feature branch with a suitable title 🚀
- Please follow common best practice when committing, provide a meaningful commit message, and split different sub-topics in separate commits 👍
- Feel free to open a draft pull request as soon as you start committing so that the community can follow the development. The core team will make sure the pull request is linked to the relevant issue, and that we keep track of the progress.
- We use
black,flake8andpylintfor code formatting and linting, and we have a test suite based onpytest. Please make sure that these checks pass before committing code ✔️ - Remember to add tests for the new features that you implement 👨🔬
- Remember to add docstrings to your functions and classes. We use the google format.
- When you feel that your contribution is ready, mark your pull request as ready for review, and we will assign some suitable reviewers 🤓
The core team continues working on the structure for the higher levels of the package. Feel free to join the discussions in the pull requests 🙋
For the moment, there are no third party dependencies to the package, but it is always useful to work in a virtual environment. To create one on Windows, type py -m venv venv, and activate it by typing venv\scripts\activate.
We use black for code formatting, flake8 and pylint for linting, and have set up our test suite using pytest. Make sure you have these installed (make deps). We have set up VS Code to use these tools automatically. Open VS Code inside the repo (code .), view the tests in the test pane on the left side, and notice how the linters highlight parts of your code that should be rewritten.
We have supplied a makefile that you may use to run formatting (make form), linting (make lint) and testing (make test). Don't have make? You can get it from chocolatey, choco install make. If you don't want to use make, feel free to e.g. py -m black structuralcodes and py -m pytest.