Usage

The most common usage is when one has a system in a given format, say OpenDSS, and wants to convert it to another format, say CYME. The convertion process will always be structured in the following way:

• Instanciate a store object which will store all the objects and attributes of your model

from ditto.store import Store
m=Store()

• Instanciate a reader object with the required arguments. These arguments may vary depending on the format. For example, the OpenDSS reader expects a path for the master.dss file as well as a path for the buscoord.dss file.

from ditto.readers.opendss.read import reader
opendss_reader=reader(master_file='/Users/johny_cash/IEEE_13_node/master.dss,
                      buscoordinates_file='/Users/johny_cash/IEEE_13_node/buscoords.dss')

• Call the parse method of the reader with the store object as argument.

opendss_reader.parse(m)

• Instanciate a writer object with the required arguments (output folder path…).

from ditto.writers.cyme.write import writer
cyme_writer=writer(output_path='./', log_path='./')

• Call the write method of the writer with the store object as argument.

cyme_writer.write(m)

How is the code structured?

Here is a simplified view of the code structure (only the key components are displayed):

DiTTo
│   README.md
│   docs
|   tests
│
└───ditto
    │   store.py
    │
    └───core
    |   │   base.py
    |   │   _factory.py
    |   │   exceptions.py
    |
    └───readers
    |   └───cyme
    |   |      |   read.py
    |   └───opendss
    |          |   read.py
    |
    └───writers
        └───cyme
        |      |   write.py
        └───opendss
               |   write.py

Most of the code is located in the ditto directory. The core structure responsible for storing the objects is implemented in the core folder. Readers are implemented in readers and writers in writers. These two folders then contain the different format in different subfolders.

Example 1: The OpenDSS reader is located in:

DiTTo/ditto/readers/opendss/read.py

And can be imported with:

from ditto.readers.opendss.read import Reader

Example 2: The CYME writer is located in:

DiTTo/ditto/writers/cyme/write.py

And can be imported with:

from ditto.writers.cyme.write import Writer