Add metadata and license

[bryanwweber]

Adds license_file metadata and additional metadata for the project

[codecov-io]

Codecov Report

Merging #8 into master will decrease coverage by 0.05%.
The diff coverage is n/a.

@@            Coverage Diff            @@
##           master      #8      +/-   ##
=========================================
- Coverage   72.65%   72.6%   -0.06%     
=========================================
  Files           7       7              
  Lines         512     511       -1     
=========================================
- Hits          372     371       -1     
  Misses        140     140

[TomTranter]

Hi @bryanwweber, thanks for this pull request. Why are you removing porespy dependency though? It is necessary for examples

[bryanwweber]

Hi @TomTranter! Indeed, but the current state is a circular dependency between pytrax and PoreSpy (i.e., PoreSpy depends on having a pytrax package, and vice versa). I'm working with @ma-sadeghi to build conda packages for OpenPNM, PoreSpy and pytrax and to do that there can't be any circular dependencies. If PoreSpy is necessary to run the example, users will need to install that themselves, rather than requiring it in setup.py.

[TomTranter]

I was planning to make notebooks for the examples anyway so I could maybe add an install line into those if the user hasn't got porespy

[bryanwweber]

IMO it would be better to do something like:

try:
    import porespy as ps
except ImportError:
    print("PoreSpy must be installed for the examples. Use pip or conda to install it")
    raise

That way, people who don't have administrator permissions don't get a strange error from trying to install PoreSpy and the actual cause of the problem is identified. Also, some people will want to use pip, others conda, others build from source, etc.

[TomTranter]

@bryanwweber good suggestion. Is this good to be merged in now? I will create a separate branch to update examples afterwards

[bryanwweber]

@TomTranter Yes, it's good from my end. BTW, thanks for considering this! I didn't include any explanation in the first comment, just kind of dropped it on your head. I had assumed that your group would know what I was doing, it seems that was my mistake! Sorry for the missing explanation 😄

[TomTranter]

@bryanwweber no worries, I'm not physically in Jeff's group anymore so everyone else probably knows what you're up to

[ma-sadeghi]

Sorry @TomTranter and @bryanwweber, my bad. I forgot to let Tom know what we were up to.

@TomTranter, we want to include Cantera as an OpenPNM dependency for mixtures, but since Cantera is not pip-installable yet, @bryanwweber offered to help us develop conda packages for our libraries so we can safely list Cantera as a dependency.