Skip to content

Commit a9d7201

Browse files
coretlcoretl
committed
pythonIoc -> pythonSoftIOC
1 parent a2450f4 commit a9d7201

File tree

9 files changed

+28
-37
lines changed

9 files changed

+28
-37
lines changed

‎README.rst‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pythonIoc
2-
=========
1+
pythonSoftIOC
2+
=============
33

44
|code_ci| |docs_ci| |coverage| |pypi_version| |license|
55

@@ -11,8 +11,8 @@ asyncio for concurrency. PVs are served over Channel Access and PVAccess.
1111

1212
============== ==============================================================
1313
PyPI ``pip install softioc``
14-
Source code https://github.com/dls-controls/pythonIoc
15-
Documentation https://dls-controls.github.io/pythonIoc
14+
Source code https://github.com/dls-controls/pythonSoftIOC
15+
Documentation https://dls-controls.github.io/pythonSoftIOC
1616
============== ==============================================================
1717

1818
A simple example of the use of this library:
@@ -46,16 +46,16 @@ A simple example of the use of this library:
4646
# Finally leave the IOC running with an interactive shell.
4747
softioc.interactive_ioc(globals())
4848
49-
.. |code_ci| image:: https://github.com/dls-controls/pythonIoc/workflows/Code%20CI/badge.svg?branch=master
50-
:target: https://github.com/dls-controls/pythonIoc/actions?query=workflow%3A%22Code+CI%22
49+
.. |code_ci| image:: https://github.com/dls-controls/pythonSoftIOC/workflows/Code%20CI/badge.svg?branch=master
50+
:target: https://github.com/dls-controls/pythonSoftIOC/actions?query=workflow%3A%22Code+CI%22
5151
:alt: Code CI
5252

53-
.. |docs_ci| image:: https://github.com/dls-controls/pythonIoc/workflows/Docs%20CI/badge.svg?branch=master
54-
:target: https://github.com/dls-controls/pythonIoc/actions?query=workflow%3A%22Docs+CI%22
53+
.. |docs_ci| image:: https://github.com/dls-controls/pythonSoftIOC/workflows/Docs%20CI/badge.svg?branch=master
54+
:target: https://github.com/dls-controls/pythonSoftIOC/actions?query=workflow%3A%22Docs+CI%22
5555
:alt: Docs CI
5656

57-
.. |coverage| image:: https://codecov.io/gh/dls-controls/pythonIoc/branch/master/graph/badge.svg
58-
:target: https://codecov.io/gh/dls-controls/pythonIoc
57+
.. |coverage| image:: https://codecov.io/gh/dls-controls/pythonSoftIOC/branch/master/graph/badge.svg
58+
:target: https://codecov.io/gh/dls-controls/pythonSoftIOC
5959
:alt: Test Coverage
6060

6161
.. |pypi_version| image:: https://img.shields.io/pypi/v/softioc.svg
@@ -70,4 +70,4 @@ A simple example of the use of this library:
7070
Anything below this line is used when viewing README.rst and will be replaced
7171
when included in index.rst
7272
73-
See https://dls-controls.github.io/pythonIoc for more detailed documentation.
73+
See https://dls-controls.github.io/pythonSoftIOC for more detailed documentation.

‎docs/conf.py‎

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,10 @@
1010
# All configuration values have a default; values that are commented out
1111
# serve to show the default.
1212

13-
import os
14-
import sys
15-
16-
# If extensions (or modules to document with autodoc) are in another directory,
17-
# add these directories to sys.path here. If the directory is relative to the
18-
# documentation root, use os.path.abspath to make it absolute, like shown here.
19-
repo_root = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
20-
sys.path.insert(0, repo_root)
21-
22-
import softioc # noqa
13+
import softioc
2314

2415
# General information about the project.
25-
project = u'pythonIoc'
16+
project = u'pythonSoftIOC'
2617
copyright = u'2008, Diamond Light Source'
2718
author = 'Michael Abbott'
2819

docs/explanations/why-use-pythonIoc.rst renamed to docs/explanations/why-use-pythonSoftIOC.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Why use pythonIOC?
2-
==================
1+
Why use pythonSoftIOC?
2+
======================
33

44
EPICS IOCs are flexible and modular, why do we need to wrap it in Python? This
55
page attempts to answer that question and list a few good use-cases for it.
@@ -8,7 +8,7 @@ Calculating PVs from other values
88
---------------------------------
99

1010
Some use cases require PVs to be calculated from multiple sources. This is
11-
possible in EPICS records with ``calc`` or ``aSub`` records, but pythonIoc
11+
possible in EPICS records with ``calc`` or ``aSub`` records, but pythonSoftIOC
1212
allows you to write this as:
1313

1414
.. code-block::
@@ -58,7 +58,7 @@ Dynamically created PVs
5858

5959
Other use cases will require PVs to be created based on the features of a
6060
device. As EPICS database records are statically created at IOC boot, you
61-
can generate the database with a script, but pythonIoc allows you to write
61+
can generate the database with a script, but pythonSoftIOC allows you to write
6262
this as:
6363

6464
.. code-block::

‎docs/how-to/make-publishable-ioc.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ the DLS environment.
88

99
Single File IOC
1010
----------------
11-
An IOC that is entirely contained within a single Python source file can be used as an
11+
An IOC that is entirely contained within a single Python source file can be used as an
1212
IOC inside DLS simply by adding this shebang line::
1313

14-
#!/dls_sw/prod/python3/RHEL7-x86_64/softioc/3.0b2/prefix/bin/pythonIoc
14+
#!/dls_sw/prod/python3/RHEL7-x86_64/softioc/3.2/prefix/bin/pythonSoftIOC
1515

1616

1717
IOC entry point for a module
1818
------------------------------
19-
If your IOC is more complicated than one file, it is recommended to write a python
19+
If your IOC is more complicated than one file, it is recommended to write a python
2020
module (including docs/tests/etc.). The Panda Blocks Client will be an example of
2121
this.
2222

‎docs/how-to/use-asyncio-in-an-ioc.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Use `asyncio` in an IOC
22
=======================
33

4-
There are two libraries available for asynchronous operations in PythonIOC:
4+
There are two libraries available for asynchronous operations in pythonSoftIOC:
55
`cothread` and `asyncio`. This guide shows how to use the latter in
66
an IOC.
77

‎docs/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Table Of Contents
6767
:name: explanations
6868
:maxdepth: 1
6969

70-
explanations/why-use-pythonIoc
70+
explanations/why-use-pythonSoftIOC
7171

7272
.. rst-class:: no-margin-after-ul
7373

‎docs/tutorials/creating-an-ioc.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Introduction
77
Once the module has been installed (see `installation`) we can create a
88
simple EPICS Input/Output Controller (IOC).
99

10-
An EPICS IOC created with the help of ``pythonIoc`` and `softioc` is
10+
An EPICS IOC created with the help of ``pythonSoftIOC`` and `softioc` is
1111
referred to as a "Python soft IOC". The code below illustrates a simple IOC
1212
with two Process Variables (PVs):
1313

@@ -19,7 +19,7 @@ Each section is explained in detail below:
1919
:start-after: # Import
2020
:end-before: # Set
2121

22-
The `softioc` library is part of ``pythonIoc``. The two submodules
22+
The `softioc` library is part of ``pythonSoftIOC``. The two submodules
2323
`softioc.softioc` and `softioc.builder` provide the basic
2424
functionality for Python soft IOCs and are the ones that are normally used.
2525

‎docs/tutorials/installation.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ the first tutorial::
4343
If you require a feature that is not currently released you can also install
4444
from github::
4545

46-
python3 -m pip install git+git://github.com/dls-controls/pythonIoc.git
46+
python3 -m pip install git+git://github.com/dls-controls/pythonSoftIOC.git
4747

4848
The library should now be installed and the commandline interface on your path.
4949
You can check the version that has been installed by typing::
5050

51-
pythonIoc --version
51+
pythonSoftIOC --version

‎setup.cfg‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[metadata]
22
name = softioc
33
description = Embed an EPICS IOC in a Python process
4-
url = https://github.com/dls-controls/pythonIoc
4+
url = https://github.com/dls-controls/pythonSoftIOC
55
author = Michael Abbott
66
author_email = [email protected]
77
license = Apache License 2.0
@@ -22,7 +22,7 @@ python_requires = >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !
2222
[options.entry_points]
2323
# Include a command line script
2424
console_scripts =
25-
pythonIoc = softioc.__main__:main
25+
pythonSoftIOC = softioc.__main__:main
2626

2727
[options.package_data]
2828
softioc =

0 commit comments

Comments
 (0)