KonstantinosRekoumis / CSR

A primitive calculator that calculates a ship midship plates and PSMs based on IACS CSR
2 stars 2 forks source link
rule-based-design shipbuilding

Constructional Strength Calculations

This was part of a ship design assignment, by SNAME @ NTUA.

Primary goal

This code is developed to aid the design of the principal strength members of a ship's Midship. For the time being is developed for Bulk Carriers, under Common Structural Rules.

Contributing

Installation

Python3.12 or later REQUIRED!

git clone git@github.com:KonstantinosRekoumis/CSR.git && cd CSR
python3 -m venv venv
source ./venv/bin/activate
pip install -r requirements.txt

Build

Configure the hooks:

# this will automatically run some predetermined steps before each stage
git config core.hooksPath ./hooks

If you want to read the generated junit reports locally, install xunit-viewer && chromium.

sudo npm install xunit-viewer -g
sudo dnf install -y --best --allowerasing chromium

Running

CLI

# activate the virtual environment mentioned above
source ./venv/bin/activate
# run
./cli.py "path/to/envelope.json"

GUI

# activate the virtual environment mentioned above
source ./venv/bin/activate
# run
./gui.py

Design Comments on the Ordinary Section

Goals

Future Extensions

LICENSE

MIT License

Copyright (c) 2022 Konstantinos Rekoumis

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.