apatite/README.md

1.8 KiB

Apatite

Apatite is a fundimental package for scientific computing in Crystal. If that sounds like a modified version of the first line from the NumPy homepage, that's because it is. Apatite has (ok, will have) all of the goodness of NumPy sitting atop the blazing speed and beautiful syntax of Crystal.

Installation

  1. Add the dependency to your shard.yml:

    dependencies:
      apatite:
        github: watzon/apatite
    
  2. Run shards install

Usage

require "apatite"

TODO: Write usage instructions here, but first write the library...

Roadmap

[ ] Apetite [ ] Array Objects [ ] NArray (see numpy.ndarray) [ ] DType (see numpy.dtype) [ ] Scalars [ ] Indexing [ ] Routines [ ] Binary Operations [ ] String Operations [ ] FFT (see numpy.fft) [ ] Financial Functions [ ] LinAlg (see numpy.linalg) [ ] Logic Functions [ ] Mathematical Functions [ ] Matlib (see numpy.matlib) [ ] Padding Arrays [ ] Polynomials [ ] Random (see numpy.random) [ ] Sorting, Searching, and Counting [ ] Statistics

Contributing

  1. Fork it (https://github.com/watzon/apatite/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors