Skip to content

Commit f3bf61a

Browse files
committed
Update documentation for new project structure
- Fix repository URLs to use michael-borck/simnexus instead of teaching-repositories - Update import statements to use the new nested module structure - Correct CLI commands to use simnexus ui web/tui instead of simnexus-web/tui - Fix typo in stock_market.md (figsise → figsize) - Add AUTHORS.md file acknowledging contributors - Update web deployment instructions to use correct app entry point
1 parent cdf632e commit f3bf61a

9 files changed

Lines changed: 60 additions & 20 deletions

File tree

AUTHORS.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# ✍️ Authors & Contributors
2+
3+
This project was made possible thanks to the following contributors:
4+
5+
## Core Author
6+
7+
- **Michael Borck**
8+
Lead developer and educational designer.
9+
GitHub: [michael-borck](https://github.com/teaching-repositories)
10+
Email: michael@borck.me
11+
12+
## AI Co-Authors
13+
14+
- **ChatGPT (OpenAI)**
15+
Provided design and code-generation assistance for the original SimNexus module.
16+
Helped with architecture, packaging, documentation, and workflow automation.
17+
Contributions include:
18+
- Project scaffolding and CI/CD
19+
- mkdocs configuration
20+
- Testing and tooling
21+
- Educational project design
22+
23+
- **Claude (Anthropic)**
24+
Provided assistance with transitioning the project to modern framework.
25+
Helped with modular architecture, web interfaces, and documentation.
26+
Contributions include:
27+
- Web interface implementation
28+
- Code restructuring and modularisation
29+
- Build system updates
30+
- Module integration
31+
- Development tools
32+
33+
## Acknowledgments
34+
35+
- Inspired by the open-source Python packaging ecosystem and educators exploring AI in the classroom.
36+
- Built with a focus on educational applications of AI in teaching and learning environments.
37+
38+
---
39+
40+
_If you’ve contributed and are not listed here, please submit a pull request to add yourself!_

docs/api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
## Product Popularity Simulation Class
44

5-
::: simnexus.ProductPopularitySimulation
5+
::: simnexus.core.product_popularity_simulation.ProductPopularitySimulation
66

77
## Resource Fluctuation Simulation Class
88

9-
::: simnexus.ResourceFluctuationsSimulation
9+
::: simnexus.core.resource_fluctuations_simulation.ResourceFluctuationsSimulation
1010

1111
## Stock Market Simulation Class
1212

13-
::: simnexus.StockMarketSimulation
13+
::: simnexus.core.stock_market_simulation.StockMarketSimulation

docs/contact.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ Please allow 24-48 hours for a response, as we strive to provide detailed and he
1414

1515
If you're experiencing technical issues or need help troubleshooting, you can:
1616

17-
- **Submit an Issue**: Visit our [GitHub Issues Page](https://github.com/teaching-repositories/simnexus/issues) to report a bug or a problem. Please check to see if your issue has already been reported or addressed before opening a new issue.
17+
- **Submit an Issue**: Visit our [GitHub Issues Page](https://github.com/michael-borck/simnexus/issues) to report a bug or a problem. Please check to see if your issue has already been reported or addressed before opening a new issue.
1818

1919
## Feature Requests
2020

2121
We are always looking to improve SimNexus and welcome your ideas and proposals for new features:
2222

23-
- **Feature Suggestions**: Please submit your feature requests through our [GitHub Issues Page](https://github.com/teaching-repositories/simnexus/issues). Tag your post with the 'feature request' label so we can easily identify it.
23+
- **Feature Suggestions**: Please submit your feature requests through our [GitHub Issues Page](https://github.com/michael-borck/simnexus/issues). Tag your post with the 'feature request' label so we can easily identify it.
2424

2525
## Follow Us
2626

docs/contribute.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
We welcome contributions from the community. Before contributing, please read our contribution guidelines to understand how you can help improve this project.
44

5-
[Read the Contribution Guidelines](https://github.com/teaching-repositories/simnexus/blob/main/CONTRIBUTING.md)
5+
[Read the Contribution Guidelines](https://github.com/michael-borck/simnexus/blob/main/CONTRIBUTING.md)

docs/getting_started.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ pip install simnexus[web]
3939
For the latest development version:
4040

4141
```bash
42-
pip install git+https://github.com/teaching-repositories/simnexus.git
42+
pip install git+https://github.com/michael-borck/simnexus.git
4343
```
4444

4545
## Verify Installation
@@ -65,7 +65,7 @@ SimNexus offers multiple ways to run simulations:
6565
Import SimNexus in your Python code:
6666

6767
```python
68-
from simnexus import StockMarketSimulation
68+
from simnexus.core.stock_market_simulation import StockMarketSimulation
6969

7070
# Create a simulation instance
7171
sim = StockMarketSimulation(
@@ -123,19 +123,19 @@ SimNexus includes comprehensive examples to help you get started:
123123
- **CLI Examples**: Shell scripts demonstrating command-line capabilities
124124
- **Jupyter Notebooks**: Interactive examples for data analysis
125125

126-
See the [examples directory](https://github.com/teaching-repositories/simnexus/tree/main/examples) in the repository.
126+
See the [examples directory](https://github.com/michael-borck/simnexus/tree/main/examples) in the repository.
127127

128128
## Next Steps
129129

130130
- Explore the [API documentation](api.md) for detailed information on simulation classes
131131
- Try different interfaces: [CLI](cli.md), [TUI](tui.md), or [Web](web.md)
132-
- Check out the [example code](https://github.com/teaching-repositories/simnexus/tree/main/examples) for practical applications
132+
- Check out the [example code](https://github.com/michael-borck/simnexus/tree/main/examples) for practical applications
133133

134134
## Getting Help
135135

136136
If you encounter any issues or have questions:
137137

138-
- Check the [documentation](https://teaching-repositories.github.io/simnexus/)
138+
- Check the [documentation](https://michael-borck.github.io/simnexus/)
139139
- Run `simnexus --help` for CLI assistance
140140
- Contact information is available on the [Contact](contact.md) page
141141

docs/stock_market.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This simulation models the fluctuations of stock prices, enabling students to ex
1616
**Example Code**
1717

1818
```python
19-
from simnexus import StockMarketSimulation
19+
from simnexus.core.stock_market_simulation import StockMarketSimulation
2020
import matplotlib.pyplot as plt
2121

2222
# Example scenario: High volatility with a downward price trend and a significant market event.
@@ -26,7 +26,7 @@ sim = StockMarketSimulation(start_price=100, days=365, volatility=0.03,
2626
prices = sim.run_simulation()
2727

2828
# Visualising the stock market fluctuations
29-
plt.figure(figsise=(10, 6))
29+
plt.figure(figsize=(10, 6))
3030
plt.plot(prices, label='Stock Price')
3131
plt.axvline(x=sim.event_day, color='red', linestyle='--', label='Major Market Event')
3232
plt.xlabel('Days')

docs/tui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ pip install simnexus[dev]
1515
Launch the TUI with:
1616

1717
```bash
18-
simnexus-tui
18+
simnexus ui tui
1919
```
2020

2121
## Interface Overview

docs/web.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ pip install simnexus[web]
1515
Start the web server with:
1616

1717
```bash
18-
simnexus-web
18+
simnexus ui web
1919
```
2020

2121
By default, the server runs on http://localhost:8000.
2222

2323
For custom host and port:
2424

2525
```bash
26-
simnexus-web --host 0.0.0.0 --port 5000
26+
simnexus ui web --host 0.0.0.0 --port 5000
2727
```
2828

2929
## Web Interface Features
@@ -80,7 +80,7 @@ FastHTML allows SimNexus to create a modern, interactive web interface without t
8080
For production deployment, we recommend using Uvicorn behind a reverse proxy like Nginx:
8181

8282
```bash
83-
uvicorn simnexus.web.app:app --host 0.0.0.0 --port 8000
83+
uvicorn simnexus.web.app:create_app --host 0.0.0.0 --port 8000
8484
```
8585

8686
Or with Docker (see the project repository for the Dockerfile).

pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,9 @@ cli = [
5858
]
5959

6060
[project.urls]
61-
Homepage = "http://yourhomepage.com"
62-
Documentation = "https://teaching-repositories.github.io/simnexus/"
63-
Repository = "https://github.com/teaching-repositories/simnexus"
61+
Homepage = "http://simnexus.borck.me"
62+
Documentation = "https://michael-borck.github.io/simnexus/"
63+
Repository = "https://github.com/michael-borck/simnexus"
6464

6565
[project.scripts]
6666
simnexus = "simnexus.cli.main:app"

0 commit comments

Comments
 (0)