Metadata-Version: 2.1
Name: espiownage
Version: 0.0.36
Summary: Ownage of ESPI image inference
Home-page: https://github.com/drscotthawley/espiownage/tree/master/
Author: Scott H. Hawley
Author-email: scott.hawley@belmont.edu
License: Apache Software License 2.0
Description: # espiownage
        
        
        
        > Ownage (domination) of ESPI image inference. (Pronounced like "espionage" but with a little "own" in the middle.)
        
        Welcome to the new phase of [SPNet](https://github.com/drscotthawley/SPNet) developement -- IN PROGRESS.  
        In this incarnation, we'll be making it an image-segmentation code instead of an object detector, and we'll use [fast.ai](fast.ai).   
        
        ## Install
        
        ### Preliminaries
        
        Ubuntu (& probably other Linuxes):
        ```bash
        sudo apt-get install python3-tk
        ```
        
        Mac (with [Homebrew](https://brew.sh/))
        ```bash
        brew install python-tk
        ```
        
        Then on all systems, let's set up a virtual environment called `espi`. 
        I like to put my environments in `~/envs`:
        
        ```
        mkdir ~/envs; python3 -m venv ~/envs/espi; source ~/envs/espi/bin/activate
        ```
        And then you want/need to update `pip` in case it gave you an ancient version:
        
        ```bash
        python3 -m pip install pip --upgrade
        ```
        
        ### Pip install
        
        ```bash
        pip install espiownage
        ```
        Note: the requirements on this package follow a "kitchen sink" approach so that everything a student might need gets installed, e.g. `jupyter` and more. (And `wheel` because it speeds up the installations...I think.)
        
        ## How to use
        
        If you're reading this, you probably have access to the "real" data, which sits (on my machine) in `~/Dropbox/Data/espiownage-data`.  So `cd` to that directory, i.e.,
        ```
        $ cd ~/Dropbox/Data/espiownage-data
        ```
        ...(or whereever you've got it) for what follows. 
        
        **AND THEN**, so we don't "clobber" each other's work, make *your own copy* (~17MB) of the main `annotations` directory, as in append your last name (hawley, morrison, morgan, etc):
        
        ```bash
        cp -r annotations annotations_yourlastname
        ```
        and then we'll each edit our own copy just to avoid...confusion. 
        > *Note:If you don't have access to the real data,* you can still grab the [fake SPNet data](https://zenodo.org/record/4445434) and then, for each of those datasets: Move (or symlink) all the images to a directory called `images/`, and all the `.csv` files to a directory called `annotations/`, and proceed.
        
        ## Console Scripts
        See the separate page on console scripts
        
        ## Contributing / Development 
        
        You'll want to install more things:
        
        ```bash
        pip install nbdev twine 
        ```
        
        Fork this repo.  When you want to update your repo, one macro does it all (see `Makefile`):
        ```bash
        make git_update
        ```
        
        ## Asides
        
        ### Handy tips for students
        I can never remember how to start up virtual environments / or I don't *want* to remember. So in my `~/.bashrc` file (you may have a `~/.zshrc`) I put in a line where I define an alias/function I call `gimme`, that reads like so:
        ```bash
        gimme() { source ~/envs/"$1"/bin/activate;  }
        ```
        (note that in order for this alias to be recognized, you need to either logout and log back in or else run `$ source ~/.bashrc`)
        
        Then when I want to load environment like `espi` I just type...
        ```bash
        gimme espi
        ```
        
        
        --Scott H. Hawley, September 2021
        
Keywords: some keywords
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
