Skip to content

reorganize code + add instruction/functions to exercise + wrap solution in comments #231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

reorganize code + add instruction/functions to exercise + wrap solution in comments #231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8f5b5b0
Update README.md
venelink Jul 16, 2024
858eedb
Merge branch 'LxMLS:master' into master
venelink Jun 18, 2025
a4cce2e
Update model.py
venelink Jun 19, 2025
6dc594e
external clip file
venelink Jun 19, 2025
70441a4
Update exercises_answers.ipynb
venelink Jun 19, 2025
b01cd80
add instruction/functions to exercise + wrap solution in comments
PaulLerner Jun 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 12 additions & 37 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,11 @@ example from the command line in do

git clone [email protected]:LxMLS/lxmls-toolkit.git lxmls-toolkit-student

If you do not have a pyhon installation, install miniconda. Go to
If you do not have a pyhon installation, install `Anaconda`. Go to

https://docs.conda.io/en/latest/miniconda.html
https://www.anaconda.com/download/

and follow the instructions for installation using Python 3.

After setting up the anaconda:
and follow the instructions for installation using Python 3. After setting up the anaconda:

use your favorite git tool to create a clone of this repository
navigate to the folder where the repository resides
Expand All @@ -47,45 +45,22 @@ After setting up the anaconda:
pip install --editable .


and follow the instructions for your platform (Windows, Linux, OSX). We reccomend
that you create your virtual environment with a recent python version i.e.
If you prefer `pip` to Anaconda you can install the toolkit in a way that does not interfere with your existing installation.
For this you can use a virtual environment as follows

cd lxmls-toolkit-student
conda create -y -p ./lxmls2023 python=3.9 -y
conda activate ./lxmls2023
virtualenv venv
source venv/bin/activate (on Windows: .\venv\Scripts\activate)
pip install pip setuptools --upgrade
pip install --editable .


Note the `./` in `./lxmls2023` -- this will install the virtual environment
locally, so if you delete `lxmls-toolkit-student` you will also remove the
environment.

Then install the toolkit, just to be sure upgrade your pip (always good)
This will install the toolkit in a way that is modifiable. Remember to run scripts from the root directory `lxmls-toolkit-student`

pip install pip setuptools --upgrade
pip install -r requirements.txt
If you want to also virtualize you Python version (e.g. you are stuck with Python2 on your system), have a look at `pyenv`.

This will install the toolkit in a way that is modifiable. Remember to run scripts from the root directory `lxmls-toolkit-student`

### Running

* Run from the project root directory. If an importing error occurs, try first adding the current path to the `PYTHONPATH` environment variable, e.g.:
* `export PYTHONPATH=.`
```
### Development

To run the all tests install `tox` and `pytest`

pip install tox pytest

and run

tox

Note, to combine the coverage data from all the tox environments run:


* Windows
set PYTEST_ADDOPTS=--cov-append

* Other
PYTEST_ADDOPTS=--cov-append tox
```
Loading