Skip to content

Commit 1a17573

Browse files
author
Daniel Precioso, PhD
committed
Initialize package structure with setup.py, MANIFEST.in, and README_PYPI.md
1 parent b8d9995 commit 1a17573

3 files changed

Lines changed: 57 additions & 0 deletions

File tree

MANIFEST.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
include amlab/**/*.py

README_PYPI.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Applied Math Lab
2+
3+
A Python package for models and utilities in collective motion, ODEs, PDEs, and more.
4+
5+
## Installation
6+
7+
From the root of the repository:
8+
9+
```
10+
pip install .
11+
```
12+
13+
## Requirements
14+
- numpy
15+
- matplotlib
16+
17+
Add more requirements as needed in `setup.py`.
18+
19+
## Usage
20+
21+
Import modules from `amlab` in your Python code:
22+
23+
```python
24+
from amlab.collective_motion import vicsek_equations
25+
```
26+
27+
## Project Structure
28+
- `amlab/` - Main Python package
29+
- `modules/` - Quarto/Markdown teaching modules
30+
- `assets/`, `data/`, `img/` - Supporting files
31+
32+
## License
33+
MIT

setup.py

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
from setuptools import find_packages, setup
2+
3+
setup(
4+
name="amlab",
5+
version="0.1.0",
6+
description="Applied Math Lab: models and utilities for collective motion, ODEs, PDEs, and more.",
7+
author="Daniel Precioso",
8+
author_email="daniel.precioso@ie.edu",
9+
packages=find_packages(),
10+
install_requires=[
11+
"numpy",
12+
"matplotlib",
13+
# Add other dependencies as needed
14+
],
15+
python_requires=">=3.11",
16+
include_package_data=True,
17+
url="https://github.com/daniprec/BAM-Applied-Math-Lab",
18+
classifiers=[
19+
"Programming Language :: Python :: 3",
20+
"License :: OSI Approved :: MIT License",
21+
"Operating System :: OS Independent",
22+
],
23+
)

0 commit comments

Comments
 (0)