Repository files navigation

PyRCS is an open-source Python package that simplifies the collection and management of railway codes used across different systems in the UK rail industry. It provides a practical toolkit for researchers, practitioners and frequent users of theRailway Codes website who work extensively with railway codes in the UK. By leveraging Python's capabilities, PyRCS enables efficient access, retrieval and manipulation of railway code data, enhancing productivity and effectiveness in working with these codes.

Duringinstallation, PyRCS includes a set of pre-packaged data. When users request data from a specific category on theRailway Codes website, PyRCS loads the corresponding pre-packaged data for that category by default. Additionally, it provides functionality for direct access to the latest data from the source website, ensuring users stay up to date. Users can also update the pre-packaged data as needed, keeping their resources synchronized with the latest developments.

With PyRCS, users can leverage Python's power to streamline workflows and enhance productivity when working with railway codes in the UK rail industry.

To install the latest version of pyrcs fromPyPI viapip:

$ pip install --upgrade pyrcs

For more information, see theInstallation.

For a concise guide on how to use PyRCS, check out theQuick Start tutorial, which includes illustrative examples for three frequently-used code categories in the UK railway system:

• Location identifiers (CRS, NLC, TIPLOC and STANOX codes)
• Engineer’s Line References (ELRs) and their associated mileage files
• Railway station data (mileages, operators and grid coordinates)

The complete PyRCS Documentation is available inHTML andPDF formats.

It is hosted onRead the Docs, and the HTML version is also accessible viaGitHub Pages. The documentation includes detailed examples, tutorials and comprehensive references to help users get the most out of PyRCS.

Fu, Q. (2020). PyRCS: an open-source tool for collecting railway codes used in different UK rail industry systems. Zenodo.doi:10.5281/zenodo.4026744

@software{Fu_PyRCS_2020,author ={Fu, Qian},title ={{PyRCS: An open-source tool for collecting railway codes used in different UK rail industry systems}},year =2020,publisher ={Zenodo},doi ={10.5281/zenodo.4026744},license ={MIT},url ={https://github.com/mikeqfu/pyrcs}}

For specific version references, please refer toZenodo.

PyRCS is licensed under theMIT License.

Please note that this project was initially licensed under theGPLv3+ up to version0.3.7. Starting with version1.0.0, it has been re-licensed under the MIT License.

PyRCS uses data available from theRailway Codes website. The time and effort that the website's editor andall contributors put in making the site and data available are fully credited.