Skip to content

Commit

Permalink
Merge pull request #52 from dss-extensions/kd/fix-documentation-links
Browse files Browse the repository at this point in the history
Fix URLs
  • Loading branch information
kdheepak authored Feb 16, 2019
2 parents 012954b + cce5d9b commit feb5ab1
Show file tree
Hide file tree
Showing 7 changed files with 22 additions and 18 deletions.
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ __pycache__/
*.py[cod]
*$py.class

*.CSV
*.csv

# C extensions
*.so

Expand Down Expand Up @@ -105,4 +108,4 @@ ENV/

*.dll

README.rst
README.rst
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# OpenDSSDirect.py
[![Travis Build Status](https://travis-ci.org/NREL/OpenDSSDirect.py.svg?branch=master)](https://travis-ci.org/NREL/OpenDSSDirect.py)
[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/github/NREL/OpenDSSDirect.py?branch=master&svg=true)](https://ci.appveyor.com/project/kdheepak/opendssdirect-py)
[![codecov](https://codecov.io/gh/NREL/OpenDSSDirect.py/branch/master/graph/badge.svg)](https://codecov.io/gh/NREL/OpenDSSDirect.py)
[![Travis Build Status](https://travis-ci.com/dss-extensions/OpenDSSDirect.py.svg?branch=master)](https://travis-ci.com/dss-extensions/OpenDSSDirect.py)
[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/github/dss-extensions/OpenDSSDirect.py?branch=master&svg=true)](https://ci.appveyor.com/project/PMeira/opendssdirect-py)
[![codecov](https://codecov.io/gh/dss-extensions/OpenDSSDirect.py/branch/master/graph/badge.svg)](https://codecov.io/gh/dss-extensions/OpenDSSDirect.py)
[![PyPI](https://img.shields.io/pypi/v/OpenDSSDirect.py.svg)](https://pypi.python.org/pypi/OpenDSSDirect.py/)
[![Documentation](https://img.shields.io/badge/docs-ready-blue.svg)](http://nrel.github.io/OpenDSSDirect.py)
[![Documentation](https://img.shields.io/badge/docs-ready-blue.svg)](http://dss-extensions.github.io/OpenDSSDirect.py)

OpenDSSDirect.py is a cross-platform Python package implements a "direct" library interface to [OpenDSS](http://smartgrid.epri.com/SimulationTool.aspx) using [dss_python](https://github.com/PMeira/dss_python/).
OpenDSS is an open-source distribution system simulator. See [OpenDSSDirect.jl](https://github.com/tshort/OpenDSSDirect.jl) for a similar package in Julia.
OpenDSSDirect.py is a cross-platform Python package implements a "direct" library interface to [OpenDSS](http://smartgrid.epri.com/SimulationTool.aspx) using [dss_python](https://github.com/dss-extensions/dss_python/).
OpenDSS is an open-source distribution system simulator. See [OpenDSSDirect.jl](https://github.com/dss-extensions/OpenDSSDirect.jl) for a similar package in Julia.

**This package is available for Windows, Mac and Linux.**

### Documentation

The documentation for this package can be found [here](http://nrel.github.io/OpenDSSDirect.py).
The documentation for this package can be found [here](http://dss-extensions.github.io/OpenDSSDirect.py).

### Installation

Expand All @@ -24,22 +24,22 @@ Open a command line interface and type the following.
pip install 'OpenDSSDirect.py[extras]'
```

See [installation](https://nrel.github.io/OpenDSSDirect.py/notebooks/Installation.html) instructions for more information.
See [installation](https://dss-extensions.github.io/OpenDSSDirect.py/notebooks/Installation.html) instructions for more information.

### Troubleshooting

It is recommended to use `conda` to install pandas, which is currently a dependency of this package.
This package interfaces with OpenDSS using the "direct" library interface, so a good understanding of OpenDSS will help troubleshooting.
There are plenty of useful resources located [here](https://sourceforge.net/p/electricdss/code/HEAD/tree/trunk/Doc/).

If you are having issues using this Python interface, feel free to open an Issue on GitHub [here](https://github.com/NREL/OpenDSSDirect.py/issues/new).
If you are having issues using this Python interface, feel free to open an Issue on GitHub [here](https://github.com/dss-extensions/OpenDSSDirect.py/issues/new).

### Thanks

Thanks to @tshort, Davis, @temcdrm, @GordStephen, @Muxelmann and @PMeira for their contributions.

See @Muxelmann's repo [here](https://github.com/Muxelmann/OpenDSSDirect.make) on how to build OpenDSS for Linux.

See @PMeira's repo [here](https://github.com/PMeira/dss_python) for the interface used in this package.
See @PMeira's repo [here](https://github.com/dss-extensions/dss_python) for the interface used in this package.

See @PMeira's repo [here](https://github.com/PMeira/electricdss-src) for changes to OpenDSS for maintaining cross platform compatibility.
See @PMeira's repo [here](https://github.com/dss-extensions/electricdss-src) for changes to OpenDSS for maintaining cross platform compatibility.
2 changes: 1 addition & 1 deletion docs/notebooks/ActiveClass.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The interface described below requires the `extras` dependencies. Please see [installation instructions](https://nrel.github.io/OpenDSSDirect.py/notebooks/Installation.html)."
"The interface described below requires the `extras` dependencies. Please see [installation instructions](https://dss-extensions.github.io/OpenDSSDirect.py/notebooks/Installation.html)."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/notebooks/GettingStarted.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"An optional `pandas` interface is also provided in the package, so making it easier to get data from OpenDSS. See [installation instructions](https://nrel.github.io/OpenDSSDirect.py/notebooks/Installation.html) for how to install the requirements for this interface."
"An optional `pandas` interface is also provided in the package, so making it easier to get data from OpenDSS. See [installation instructions](https://dss-extensions.github.io/OpenDSSDirect.py/notebooks/Installation.html) for how to install the requirements for this interface."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/notebooks/Installation.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
"metadata": {},
"source": [
"```bash\n",
"git clone https://github.com/NREL/OpenDSSDirect.py.git\n",
"git clone https://github.com/dss-extensions/OpenDSSDirect.py.git\n",
"```"
]
},
Expand Down
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ def run(self):
version=version,
description="Python direct-mode interface to OpenDSS",
long_description=long_description,
url="https://github.com/NREL/OpenDSSDirect.py",
download_url="https://github.com/NREL/OpenDSSDirect.py",
url="https://github.com/dss-extensions/OpenDSSDirect.py",
download_url="https://github.com/dss-extensions/OpenDSSDirect.py",
# Author details
author="Dheepak Krishnamurthy",
author_email="[email protected]",
author_email="[email protected]",
license="BSD-compatible",
packages=find_packages(),
install_requires=["future", "six", "dss_python==0.10.0"],
Expand Down
1 change: 1 addition & 0 deletions tests/test_opendssdirect.py
Original file line number Diff line number Diff line change
Expand Up @@ -1726,6 +1726,7 @@ def test_13Node_Lines(dss):
2.658753201413196,
-8.847115639537611,
]
dss.Lines.Yprim(dss.Lines.Yprim())

assert dss.Lines.R0() == 3.378880258497484e-05
assert dss.Lines.X0() == 7.664982290436836e-05
Expand Down

0 comments on commit feb5ab1

Please sign in to comment.