Metadata-Version: 2.1
Name: pythondata-cpu-mor1kx
Version: 5.0.post136
Summary: Python module containing verilog files for OpenRISC1000 cpu.
Home-page: https://github.com/litex-hub/pythondata-cpu-mor1kx
Author: LiteX Authors
Author-email: litex@googlegroups.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/litex-hub/pythondata-cpu-mor1kx/issues
Project-URL: Source Code, https://github.com/litex-hub/pythondata-cpu-mor1kx
Description: # pythondata-cpu-mor1kx
        
        Non-Python  files needed for the cpu mor1kx packaged
        into a Python module so they can be used with Python libraries and tools.
        
        This Useful for usage with tools like
        [LiteX](https://github.com/enjoy-digital/litex.git).
        
        The data files can be found under the Python module `pythondata_cpu_mor1kx`. The
        `pythondata_cpu_mor1kx.data_location` value can be used to find the files on the file
        system.
        
        Example of getting the data file directly;
        ```python
        import pythondata_cpu_mor1kx
        
        my_data_file = "abc.txt"
        
        with open(os.path.join(pythondata_cpu_mor1kx.data_location, my_data_file)) as f:
            print(f.read())
        ```
        
        Example of getting the data file using `litex.data.find` API;
        ```python
        from pythondata_cpu_mor1kx import data_file
        
        my_data_file = "abc.txt"
        
        with open(data_file(my_data_file)) as f:
            print(f.read())
        ```
        
        
        The data files come from https://github.com/openrisc/mor1kx.git
        and are imported using `git subtrees` to the directory
        [pythondata_cpu_mor1kx/verilog](pythondata_cpu_mor1kx/verilog).
        
        
        
        ## Installing from git repository
        
        ## Manually
        
        You can install the package manually, however this is **not** recommended.
        
        ```
        git clone https://github.com/litex-hub/pythondata-cpu-mor1kx.git
        cd pythondata-cpu-mor1kx
        sudo python setup.py install
        ```
        
        ## Using [pip](https://pip.pypa.io/) with git repository
        
        You can use [pip](https://pip.pypa.io/) to install the data package directly
        from github using;
        
        ```
        pip install --user git+https://github.com/litex-hub/pythondata-cpu-mor1kx.git
        ```
        
        If you want to install for the whole system rather than just the current user,
        you need to remove the `--user` argument and run as sudo like so;
        
        ```
        sudo pip install git+https://github.com/litex-hub/pythondata-cpu-mor1kx.git
        ```
        
        You can install a specific revision of the repository using;
        ```
        pip install --user git+https://github.com/litex-hub/pythondata-cpu-mor1kx.git@<tag>
        pip install --user git+https://github.com/litex-hub/pythondata-cpu-mor1kx.git@<branch>
        pip install --user git+https://github.com/litex-hub/pythondata-cpu-mor1kx.git@<hash>
        ```
        
        ### With `requirements.txt` file
        
        Add to your Python `requirements.txt` file using;
        ```
        -e git+https://github.com/litex-hub/pythondata-cpu-mor1kx.git
        ```
        
        To use a specific revision of the repository, use the following;
        ```
        -e https://github.com/litex-hub/pythondata-cpu-mor1kx.git@<hash>
        ```
        
        ## Installing from [PyPi](https://pypi.org/project/pythondata-cpu-mor1kx/)
        
        ## Using [pip](https://pip.pypa.io/)
        
        ```
        pip install --user pythondata-cpu-mor1kx
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown
