new setup.py and build package via pip

Author: Mascagni-ML

MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md LICENSE
+recursive-include src/IHSetBernabeu *.py

README.md

@@ -1,26 +1,39 @@
 # IHSetBernabeu
+Python package to run and calibrate the Bernabeu et al. (2003) equilibrium beach profile model.
 
-Bernabeu et al. (2003) proposed a two-section equilibrium beach profile model (2S-EBP) based on the concept of the previous studies. This model is useful for predicting the equilibrium beach profile under various conditions.
 
+## :house: Local Installation
+* Using pip:
 
-## Installation and use
+```bash
 
-To install this module use:
-
-```sh
-pip install https://github.com/IHCantabria/IHSetBernabeu/archive/refs/tags/latest.zip
+pip install ...
 ```
 
-Run tests to validate:
-
-```sh
-ihsetbernabeu-tests
-```
+## Run test
+fron IHSetBernabeu/test folder, type:
+python test.py
 
 ## Documentation
-
 Documentation is available at https://ihcantabria.github.io/IHSetBernabeu
 
-## Credits
-
-Developed and maintained by Lim, Changbin @ IHCantabria.
+## Package structure
+IHSetBernabeu
+|
+├── LICENSE
+├── README.md
+├── src
+    ├── IHSetBernabeu
+       ├── bernabeu.py
+       └── cal_bernabeu.py
+├── test
+    ├── test.py
+    └── XY_PuertoChiquito_clean.csv
+├── setup.py
+└── .gitignore
+
+## :incoming_envelope: Contact us
+:snake: For code-development issues contact :man_technologist: [Lucas de Freitas](https://github.com/defreitasL) @ :office: [IHCantabria](https://github.com/IHCantabria)
+
+## :copyright: Credits
+Developed by :man_technologist: [Lucas de Freitas](https://github.com/defreitasL) @ :office: [IHCantabria](https://github.com/IHCantabria).

setup.py

@@ -1,26 +1,34 @@
 from setuptools import setup, find_packages
 
 setup(
-    name='IHSetBernabeu',
-    version='0.1.0',
-    packages=find_packages(),
+    name="IHSetBernabeu",
+    version="0.1.0",
+    description="Equilibrium beach profile, Bernabeu et al. (2003)",
+    author="Lucas de Freitas Pereira",
+    author_email="lucas.defreitas@unican.es",
+    url="https://github.com/IHCantabria/IHSetBernabeu",
+    license="MIT",
+
+    # ### critical step for src layout ###
+    package_dir={"": "src"},
+    packages=find_packages(where="src"),
+
     include_package_data=True,
     install_requires=[
-        'numpy',
-        'pandas',
-        'matplotlib',
-        'scipy',
-        'xarray',
-        'numba'
+        "numpy>=1.20",
+        "pandas>=1.1",
+        "matplotlib>=3.0",
+        "scipy>=1.5",
+        "xarray>=0.15",
+        "numba>=0.50"
     ],
-    author='Lucas de Freitas Pereira',
-    author_email='lucas.defreitas@unican.es',
-    description='IH-SET Bernabeu et al. (2003)',
-    url='https://github.com/IHCantabria/IHSetBernabeu',
+
     classifiers=[
-        'Development Status :: 3 - Alpha',
-        'Intended Audience :: Science/Research',
-        'License :: OSI Approved :: MIT License',
-        'Programming Language :: Python :: 3'
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Science/Research",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
     ],
+
+    python_requires=">=3.7",
 )

src/IHSetBernabeu.egg-info/PKG-INFO.txt

@@ -1,11 +1,12 @@
-LICENSE
-README.md
-setup.py
-src/IHSetBernabeu/__init__.py
-src/IHSetBernabeu/bernabeu_r2.py
-src/IHSetBernabeu/cal_bernabeu_r2.py
-src/IHSetBernabeu.egg-info/PKG-INFO
-src/IHSetBernabeu.egg-info/SOURCES.txt
-src/IHSetBernabeu.egg-info/dependency_links.txt
-src/IHSetBernabeu.egg-info/requirement.txt
-src/IHSetBernabeu.egg-info/top_level.txt
+MANIFEST.in
+README.md
+setup.py
+src/IHSetBernabeu/__init__.py
+src/IHSetBernabeu/bernabeu.py
+src/IHSetBernabeu/cal_bernabeu.py
+src/IHSetBernabeu.egg-info/PKG-INFO
+src/IHSetBernabeu.egg-info/SOURCES.txt
+src/IHSetBernabeu.egg-info/dependency_links.txt
+src/IHSetBernabeu.egg-info/requires.txt
+src/IHSetBernabeu.egg-info/top_level.txt
+test/test.py

src/IHSetBernabeu.egg-info/SOURCES.txt

@@ -0,0 +1 @@
+

src/IHSetBernabeu.egg-info/dependency_links.txt

@@ -1 +1 @@
-IHSetBernabeu
+IHSetBernabeu