PyRCS is an open-source Python package designed to simplify the collection and management of diverse codes used in different systems within the UK rail industry. It serves as a practical toolkit for researchers, practitioners, and individuals who frequently interact with the Railway Codes website and work extensively with railway codes in the UK. Leveraging the capabilities of the Python programming language, PyRCS enables efficient access to and manipulation of railway code data, enhancing productivity and effectiveness in working with these codes.
During installation, PyRCS includes a set of pre-packaged data. When users request data from a specific category listed on the Railway Codes website, PyRCS automatically loads the corresponding pre-packaged data for that category by default. Additionally, it provides functionality that enables direct access to the latest data from the data source website, ensuring users can stay updated with the most current information. Furthermore, PyRCS users can conveniently update the relevant pre-packaged data, keeping their data 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 from PyPI via pip:
$ pip install --upgrade pyrcsFor more information, see the Installation.
For a concise guide on how to use PyRCS, check out the Quick 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 in HTML and PDF formats.
It is hosted on ReadTheDocs and includes detailed usage examples.
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{qian_fu_pyrcs_4026744,
author = {Qian Fu},
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},
url = {https://doi.org/10.5281/zenodo.4026744}
}For specific version references of PyRCS, please refer to Zenodo.
PyRCS (since v1.0.0) is licensed under the MIT License.
PyRCS uses data available from the Railway Codes website. The time and effort that the website's editor and all contributors put in making the site and data available are fully credited.