|
13 | 13 |
|
14 | 14 | # PyGridSim |
15 | 15 |
|
16 | | -Package to simulate OpenDSS circuits on Python. |
17 | | - |
18 | | -NOTE: README comes from dai cookie cutter, will be updated |
19 | | -NOTE: will be moved to Dai lab repository |
| 16 | +PyGridSim is a package with the goal of simulating OpenDSS circuits on Python. PyGridSim uses a functional interface to allow users to efficiently generate circuits of various scopes. |
20 | 17 |
|
21 | 18 | - Documentation: https://amzhao.github.io/PyGridSim |
22 | 19 | - Homepage: https://github.com/amzhao/PyGridSim |
23 | 20 |
|
24 | 21 | # Overview |
25 | 22 |
|
26 | | -PyGridSim aims to provide accessible access to tools like OpenDSS, AltDSS using Python. The goal is to create large-scale electrical circuits representing residential neighborhoods (and other scenarios) using an intuitive interface, without any background in OpenDSS software. |
| 23 | +PyGridSim allows user to create circuits with the amount of customization they desire. Thus, users can either fully specify each component they add to the circuit, or lean on library-provided parameter sets. PyGridSim supports the batch creation of every circuit component, emphasizing scalability and efficiently in building large circuits. |
27 | 24 |
|
28 | 25 | # Install |
29 | 26 |
|
30 | 27 | ## Requirements |
31 | 28 |
|
32 | | -**PyGridSim** has been developed and tested on [Python 3.5, 3.6, 3.7 and 3.8](https://www.python.org/downloads/) |
| 29 | +**PyGridSim** has been developed and tested on [Python 3.10, 3.11 and 3.12](https://www.python.org/downloads/) |
33 | 30 |
|
34 | 31 | Also, although it is not strictly required, the usage of a [virtualenv](https://virtualenv.pypa.io/en/latest/) |
35 | 32 | is highly recommended in order to avoid interfering with other software installed in the system |
36 | 33 | in which **PyGridSim** is run. |
37 | 34 |
|
38 | | -These are the minimum commands needed to create a virtualenv using python3.6 for **PyGridSim**: |
| 35 | +These are the minimum commands needed to create a virtualenv using python3.10 for **PyGridSim**: |
39 | 36 |
|
40 | 37 | ```bash |
41 | 38 | pip install virtualenv |
42 | | -virtualenv -p $(which python3.6) PyGridSim-venv |
| 39 | +virtualenv -p $(which python3.10) PyGridSim-venv |
43 | 40 | ``` |
44 | 41 |
|
45 | 42 | Afterwards, you have to execute this command to activate the virtualenv: |
@@ -75,23 +72,8 @@ git checkout stable |
75 | 72 | make install |
76 | 73 | ``` |
77 | 74 |
|
78 | | -## Install for Development |
79 | | - |
80 | | -If you want to contribute to the project, a few more steps are required to make the project ready |
81 | | -for development. |
82 | | - |
83 | | -Please head to the [Contributing Guide](https://amzhao.github.io/PyGridSim/contributing.html#get-started) |
84 | | -for more details about this process. |
85 | | - |
86 | | -# Quickstart |
87 | | - |
88 | | -In this short tutorial we will guide you through a series of steps that will help you |
89 | | -getting started with **PyGridSim**. |
90 | | - |
91 | | -TODO: Create a step by step guide here. Also figure out how to ensure prerequisites properly. |
92 | | - |
93 | 75 | # What's next? |
94 | 76 |
|
95 | 77 | For more details about **PyGridSim** and all its possibilities |
96 | 78 | and features, please check the [documentation site]( |
97 | | -https://amzhao.github.io/PyGridSim/). |
| 79 | +TODO: gitbool link). |
0 commit comments