Skip to content

Update README and Add HistoryMD #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amzhao16 merged 3 commits into from
May 2, 2025
Merged

Update README and Add HistoryMD #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
24b3d80
add imports to readme
amzhao16 May 1, 2025
2c8c71a
add history md
amzhao16 May 1, 2025
7fbda14
link fix
amzhao16 May 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion HISTORY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,13 @@
# History
History
=======
## 0.1.0 - 2025-05-01

First PyGridSim release to PyPI: https://pypi.org/project/pygridsim/

* Add Proper Packaging - [PR #1](https://github.com/DAI-Lab/PyGridSim/pull/1) by @sarahmish
* Add Type Checking, Exports, Enum Config File, Generators/PV - [PR #3](https://github.com/DAI-Lab/PyGridSim/pull/3) by @amzhao16
* Pass Github Actions - [PR #5](https://github.com/DAI-Lab/PyGridSim/pull/5) by @amzhao16
* Add Naming Consistency, Customization Tests - [PR #6](https://github.com/DAI-Lab/PyGridSim/pull/6) by @amzhao16
* Support User Query Functions - [PR #7](https://github.com/DAI-Lab/PyGridSim/pull/7) by @amzhao16
* Enhance Results.py - [PR #8](https://github.com/DAI-Lab/PyGridSim/pull/8) by @amzhao16
* Update README - [PR #11](https://github.com/DAI-Lab/PyGridSim/pull/11) by @amzhao16
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ Users of PyGridSim have the option between creating a fully customized circuit a

## Customized Circuit Creation
```python
from pygridsim import PyGridSim
circuit = PyGridSim()

# Add Custom Source and Load
Expand All @@ -99,6 +100,7 @@ Note that the losses here are expressed in Watts, and the Voltages in Volts. The

## Defaults-Based Circuit Creation
```python
from pygridsim import PyGridSim
circuit = PyGridSim()

# Add Custom Source and Load
Expand Down