update license to BSD 3-Clause

add copyrights in files
update deps
run flake8 in all dirs
update README
add history
add Guy to authors
set version to 0.0.0

.flake8

@@ -1,4 +1,3 @@
 [flake8]
 max-line-length=100
 extend-ignore=E203,D104,D100,I004
-exclude=*/tests/*,docs/source/tools/*

AUTHORS.md

@@ -1 +1,2 @@
-* Adrien DELSALLE <[email protected]>
+- Adrien DELSALLE <[email protected]>
+- Guy de Spiegeleer <[email protected]>

HISTORY.md

@@ -0,0 +1,14 @@
+# History
+
+## 0.0.1 (2022-05-25)
+
+### Features
+
+- First release
+  - base models added: compressor, turbine, combustor, etc.
+  - systems/assemblies added: fan module, gas generator, etc.
+
+### Code quality & packaging
+
+- Package structure (license file, etc.)
+- Tests using `pytest`

LICENSE

@@ -1,3 +1,29 @@
-Copyright (c) 2022 twiinIT
+BSD 3-Clause License
 
-All rights reserved
+Copyright (c) 2022, twiinIT
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,3 +1,7 @@
-# Turbomachinery demos
+# pyTurbo
 
-This repository contains demonstration of turbomachinery applications.
+`pyTurbo` is a library for turbomachinery simulation.
+
+This project primarilly focuses on learning how components and assemblies of turbomachinery parts are interacting during operation but also how they are designed together.
+
+Note: the modelings are simplified/simplistic, they do **not** match precision expectations for industrial use.

environment-dev.yml

@@ -4,6 +4,10 @@ channels:
 dependencies:
   - cosapp
   - pyoccad
+  - numpy
   - pythreejs
   - pytest
   - pre-commit
+  - black
+  - flake8
+  - isort

environment.yml

@@ -0,0 +1,7 @@
+name: pyturbo
+channels:
+  - conda-forge
+dependencies:
+  - cosapp
+  - pyoccad
+  - numpy

pyturbo/__init__.py

@@ -0,0 +1,2 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause

pyturbo/_version.py

@@ -1 +1,4 @@
-__version__ = "0.0.1"
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
+__version__ = "0.0.0"

pyturbo/mft/__init__.py

@@ -0,0 +1,2 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause

pyturbo/mft/compressor.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 import numpy as np
 
 

pyturbo/ports/__init__.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from pyturbo.ports.fluidport import FluidPort  # noqa
 from pyturbo.ports.keypoints import KeypointsPort  # noqa
 from pyturbo.ports.shaftport import ShaftPort  # noqa

pyturbo/ports/fluidport.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from cosapp.ports import Port
 
 

pyturbo/ports/keypoints.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 import numpy as np
 from cosapp.ports import Port
 

pyturbo/ports/shaftport.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from cosapp.ports import Port
 
 

pyturbo/systems/__init__.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from pyturbo.systems.combustor import (  # noqa
     CombustorSimple,
     CombustorSimpleAero,

pyturbo/systems/atmosphere.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from cosapp.systems import System
 
 from pyturbo.ports.fluidport import FluidPort

pyturbo/systems/combustor/__init__.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from pyturbo.systems.combustor.combustor_simple_aero import CombustorSimpleAero  # noqa
 from pyturbo.systems.combustor.combustor_simple_geom import CombustorSimpleGeom  # noqa
 

pyturbo/systems/combustor/combustor_simple.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from cosapp.systems import System
 
 from pyturbo.systems.combustor import CombustorSimpleAero, CombustorSimpleGeom

pyturbo/systems/combustor/combustor_simple_aero.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from cosapp.systems import System
 
 from pyturbo.ports import FluidPort

pyturbo/systems/combustor/combustor_simple_geom.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from pyturbo.systems.generic.generic_simple_geom import GenericSimpleGeom
 
 

pyturbo/systems/compressor/__init__.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from pyturbo.systems.compressor.compressor_mft_aero import CompressorMftAero  # noqa
 from pyturbo.systems.compressor.compressor_simple_aero import CompressorSimpleAero  # noqa
 from pyturbo.systems.compressor.compressor_simple_geom import CompressorSimpleGeom  # noqa

pyturbo/systems/compressor/compressor_mft_aero.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 import numpy as np
 from cosapp.systems import System
 

pyturbo/systems/compressor/compressor_simple.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from cosapp.systems import System
 
 from pyturbo.systems.compressor import CompressorSimpleAero, CompressorSimpleGeom

pyturbo/systems/compressor/compressor_simple_aero.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from math import sqrt
 
 import numpy as np

pyturbo/systems/compressor/compressor_simple_geom.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 import numpy as np
 
 from pyturbo.systems.generic.generic_simple_geom import GenericSimpleGeom

pyturbo/systems/gas_generator/__init__.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from pyturbo.systems.gas_generator.gas_generator_simple import (  # noqa # isort: skip
     GasGeneratorSimple,
 )

pyturbo/systems/gas_generator/gas_generator_simple.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from cosapp.systems import System
 from pyoccad.create import CreateTopology
 

pyturbo/systems/gas_generator/gas_generator_simple_aero.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from cosapp.systems import System
 
 from pyturbo.systems import CombustorSimpleAero, CompressorSimpleAero, TurbineSimpleAero

pyturbo/systems/gas_generator/gas_generator_simple_geom.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 import numpy as np
 from cosapp.systems import System
 

pyturbo/systems/generic/__init__.py

@@ -1 +1,4 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from pyturbo.systems.generic.generic_simple_geom import GenericSimpleGeom  # noqa

pyturbo/systems/generic/generic_simple_geom.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 import numpy as np
 from cosapp.systems import System
 from pyoccad.create import CreateAxis, CreateRevolution, CreateTopology, CreateWire

pyturbo/systems/inlet_simple_aero.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from cosapp.systems import System
 
 from pyturbo.ports import FluidPort

pyturbo/systems/mixer_aero.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from cosapp.systems import System
 
 from pyturbo.ports.fluidport import FluidPort

pyturbo/systems/nacelle_simple_geom.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 import numpy as np
 from cosapp.systems import System
 from OCC.Core.gp import gp_Pnt

pyturbo/systems/nozzle_simple_aero.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from math import sqrt
 
 from cosapp.systems import System

pyturbo/systems/shaft.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from typing import Collection
 
 import numpy as np

pyturbo/systems/turbine/__init__.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from pyturbo.systems.turbine.turbine_simple_aero import TurbineSimpleAero  # noqa
 from pyturbo.systems.turbine.turbine_simple_geom import TurbineSimpleGeom  # noqa
 

pyturbo/systems/turbine/turbine_simple.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from cosapp.systems import System
 
 from pyturbo.systems.turbine import TurbineSimpleAero, TurbineSimpleGeom

pyturbo/systems/turbine/turbine_simple_aero.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from math import sqrt
 
 import numpy as np

pyturbo/systems/turbine/turbine_simple_geom.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 import numpy as np
 
 from pyturbo.systems.generic.generic_simple_geom import GenericSimpleGeom

pyturbo/systems/turbofan_weight.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 from cosapp.systems import System
 
 

pyturbo/thermo/__init__.py

@@ -0,0 +1,2 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause

pyturbo/thermo/ideal_gas.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 import numpy as np
 
 

setup.cfg

@@ -1,18 +1,20 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 [metadata]
 name = pyturbo
 version = attr: pyturbo._version.__version__
-author = Adrien DELSALLE
-description = twiinIT demos based on simple use cases
+author = twiinIT
+description = turbomachinery models
 long_description = file: README.md, HISTORY.md
-home-page = http://github/twiinit/turbomachinery-demos.git
-license = Proprietary License
-license-file = LICENSE
-keywords = demos, twiinit, turbomachinery
+home-page = http://github/twiinit/pyturbo.git
+license = BSD 3-clause
+keywords = twiinit, turbomachinery
 classifiers =
 	Intended Audience :: End Users/Desktop
 	Intended Audience :: Developers
 	Intended Audience :: Science/Research
-	License :: Other/Proprietary License
+	License :: OSI Approved :: BSD License
 	Natural Language :: English
 	Programming Language :: Python :: 3
 

setup.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 """The setup script."""
 
 from setuptools import setup

tests/__init__.py

@@ -0,0 +1,2 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause

tests/test_atmosphere.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 import pytest
 
 from pyturbo.systems.atmosphere import Atmosphere

tests/test_compressor.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 import numpy as np
 import pytest
 from cosapp.drivers import NonLinearSolver

tests/test_generic_geom.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 import numpy as np
 
 from pyturbo.systems.generic.generic_simple_geom import GenericSimpleGeom

tests/test_ideal_gas.py

@@ -1,3 +1,6 @@
+# Copyright (C) 2022, twiinIT
+# SPDX-License-Identifier: BSD-3-Clause
+
 import numpy as np
 
 from pyturbo.thermo.ideal_gas import IdealDryAir, IdealGas