diff options
| -rw-r--r-- | code/frontEnd/Workspace.rst | 2 | ||||
| -rw-r--r-- | code/modelEditor/modelEditor.rst | 2 | ||||
| -rw-r--r-- | code/projectManagement.rst | 4 | ||||
| -rw-r--r-- | conf.py | 5 | ||||
| -rw-r--r-- | index.rst | 20 | ||||
| -rw-r--r-- | setup.py | 19 | ||||
| -rw-r--r-- | src/kicadtoNgspice/Convert.py | 4 | ||||
| -rw-r--r-- | src/kicadtoNgspice/Source.py | 12 | ||||
| -rw-r--r-- | src/projManagement/newProject.py | 6 |
9 files changed, 59 insertions, 15 deletions
diff --git a/code/frontEnd/Workspace.rst b/code/frontEnd/Workspace.rst index 8f45816f..8722c745 100644 --- a/code/frontEnd/Workspace.rst +++ b/code/frontEnd/Workspace.rst @@ -2,4 +2,4 @@ Workspace Component =================== .. automodule:: frontEnd.Workspace - :pmembers: + :members: diff --git a/code/modelEditor/modelEditor.rst b/code/modelEditor/modelEditor.rst index 66f115e7..61aa5300 100644 --- a/code/modelEditor/modelEditor.rst +++ b/code/modelEditor/modelEditor.rst @@ -3,4 +3,4 @@ Model Editor Component .. automodule:: modelEditor.ModelEditor :members: - +
\ No newline at end of file diff --git a/code/projectManagement.rst b/code/projectManagement.rst index ecf01006..1122fc91 100644 --- a/code/projectManagement.rst +++ b/code/projectManagement.rst @@ -1,5 +1,5 @@ Project Management Component -========================== +============================ .. toctree:: :maxdepth: 2 @@ -8,5 +8,7 @@ Project Management Component projectManagement/Kicad projectManagement/Validation projectManagement/Worker + projectManagement/openProject + projectManagement/newProject @@ -16,7 +16,8 @@ import os import sys sys.path.insert(0, os.path.abspath('./src')) -autodoc_mock_imports = ['src/configuration/Appconfig'] +# added so that do not need to install them at runtime +autodoc_mock_imports = ["PyQt4","pathmagic","matplotlib","numpy"] # -- Project information ----------------------------------------------------- project = u'eSim' @@ -75,7 +76,7 @@ pygments_style = None # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = "alabaster" +html_theme = "default" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. @@ -6,6 +6,26 @@ Welcome to eSim's documentation! ================================ +.. image:: ./images/ki-ng.png + :width: 100px + :target: file:///home/neel/Projects/eSim/_build/code/kicadtoNgspice.html + +.. image:: ./images/kicad.png + :width: 100px + :target: file:///home/neel/Projects/eSim/_build/code/projectManagement/Kicad.html + +.. image:: ./images/model.png + :width: 100px + :target: file:///home/neel/Projects/eSim/_build/code/modelEditor.html + +.. image:: ./images/ngspice.png + :width: 100px + :target: file:///home/neel/Projects/eSim/_build/code/ngspiceSimulation.html + +.. image:: ./images/subckt.png + :width: 100px + :target: file:///home/neel/Projects/eSim/_build/code/subcircuit.html + .. toctree:: :maxdepth: 3 :caption: Contents: diff --git a/setup.py b/setup.py new file mode 100644 index 00000000..7a504733 --- /dev/null +++ b/setup.py @@ -0,0 +1,19 @@ +from setuptools import setup, find_namespace_packages, Command # Always prefer setuptools over distutils + +''' +Created for packaging and distributing of python projects +Makes it easier to get an overview of the project and dependencies +Also needed for `Read the docs` iinstallation and creating autodocs +Needed to define the module structure, look up `Modules` for python +''' +setup( + name='eSim', + version='1.1.3', + author='Fossee', + author_email='info@fossee.in', + package_dir={'': 'src'}, + packages=find_namespace_packages(where='src'), + license='LICENSE', + description='Useful circuit simulation library', + long_description=open('README.md').read(), +)
\ No newline at end of file diff --git a/src/kicadtoNgspice/Convert.py b/src/kicadtoNgspice/Convert.py index d59708de..883ba534 100644 --- a/src/kicadtoNgspice/Convert.py +++ b/src/kicadtoNgspice/Convert.py @@ -8,9 +8,9 @@ from xml.etree import ElementTree as ET class Convert: """ - - This class has all the necessary function required to convert + - This class has all the necessary function required to convert \ kicad netlist to ngspice netlist. - - Method List - + - Method List - - addDeviceLibrary - - addModelParameter - - addSourceParameter diff --git a/src/kicadtoNgspice/Source.py b/src/kicadtoNgspice/Source.py index f4bd3f55..26555197 100644 --- a/src/kicadtoNgspice/Source.py +++ b/src/kicadtoNgspice/Source.py @@ -27,7 +27,7 @@ class Source(QtGui.QWidget): def createSourceWidget(self, sourcelist, sourcelisttrack): """ - - This function dynamically create source widget in the + - This function dynamically create source widget in the \ Source tab of KicadtoNgSpice window - Depending on the type of source, sourcetab is created - - ac @@ -36,12 +36,12 @@ class Source(QtGui.QWidget): - - pulse - - pwl - - exp - - All the entry fields, are kept into the entry_var + - All the entry fields, are kept into the entry_var \ tracked by self.count - - Finally after each of the sourcelist is mapped to its input component - we move to adding these to the track widget - - Also check if any default values present from previous analysis & add - them by default + - Finally after each of the sourcelist is mapped to its input \ + component we move to adding these to the track widget + - Also check if any default values present from previous analysis \ + & add them by default - Each line in sourcelist corresponds to a source - According to the source type modify the source and add it to the tab """ diff --git a/src/projManagement/newProject.py b/src/projManagement/newProject.py index 70ff5789..92e90742 100644 --- a/src/projManagement/newProject.py +++ b/src/projManagement/newProject.py @@ -36,9 +36,11 @@ class NewProjectInfo(QtGui.QWidget): def createProject(self, projName): """ - This function create Project related directories and files + This function create Project related directories and files. Before creating also validates using the `Validation` class - Validation codes - + + Validation codes + - VALID - CHECKEXIST - CHECKNAME |