Skip to content
This repository has been archived by the owner on Mar 2, 2024. It is now read-only.

Latest commit

 

History

History
79 lines (47 loc) · 3.41 KB

README.md

File metadata and controls

79 lines (47 loc) · 3.41 KB
Raw

SOCAD

Client: Python -V client Server: Python -V server Documentation Status License: GPL v3

This project is no longer maintained, as I no longer have access to Cadence Virtuoso. If you are interested in contributing and have any questions, feel free to contact me.

SOCAD connects Cadence Virtuoso to a Python client. The communication between both processes is made through a server, using the following mechanisms:

  • Cadence<->Server: Inter-process communication (IPC). The server is invoked by Cadence and waits for a client communication.
  • Client<->Server: Sockets (more info here). Both processes can be run on the same machine or on different machines, according to the socket type chosen by the user. TCP sockets are used by default.

By using this library it is possible to control the Cadence environment from an external program.

Installation

The installation needs to be performed both in the client and the server. We recommend you to use pip to install SOCAD in your system.

Install with pip

Although the project is not in PyPI, you can install it using pip. Go to the project folder and run:

pip install .

NOTE: run pip install socad from the project directory doesn't work because pip will look for the package on PyPi.

Build from source

Go to the project folder and run:

python setup.py install

Use as local module

If the Cadence machine does not allow to install the socad package from the methods above, the module is loaded from examples/socad_cadence/server.py.

Usage

Import the Client or the Server to your program using:

from socad import Client
from socad import Server

The available functions of each class are available in the project library reference.

A complete demonstration of the program usage can be found in the example below.

Example

The provided example runs simulations in Cadence Virtuoso from a client in a different machine (connected through ssh), by executing OCEAN scripts provided by the user.

For more a step by step guide of the example, check this tutorial.

Versioning

We use SemVer for versioning. For the versions available, see the releases on the project repository.

Main Contributors

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

License

This project is licensed under the GPLv3 License - see the project LICENSE file for details.