Skip to content

SFCurve is a Scala library for the creation, transformation, and querying of space-filling curves

License

Notifications You must be signed in to change notification settings

geomesa/sfcurve

 
 

Repository files navigation

SFCurve

sfcurve-space-diagram

What is SFCurve?

This library represents a collaborative attempt to create a solid, robust and modular library for dealing with space filling curves on the JVM.

To read up on the collaborative effort to define the interface, and to participate in the discussion, see Issue #3.

Where can I learn more about the project?

A more detailed account of the origin and intention can be found in the proposal of the SFCurve project submitted to LocationTech. You can also find more information by contacting any of the current collaborators, or by asking about it on the GeoTrellis, GeoMesa, or GeoWave mailing lists.

Can I use SFCurve now?

This library is a complete work in progress, and is NOT recommended for current use. In the future, though, we hope to be the definitive library for working with space filling curves on the JVM. If you have ideas on how to get us there, please participate!

Working with SFCurve

The build tool used in this project is sbt. A script is included that will download the necessary sbt software, so you do not need sbt installed on the machine to work with this project.

To drop into the sbt console, where you can execute various commands, simply type

> ./sbt

in your shell.

In the below examples curve >, bechmarks > etc. represents the sbt console prompt.

Once in the sbt console, to compile the code, issue the command:

curve > compile

To test the code:

curve > test

To start a scala console which has the core sfcurve code in the classpath:

curve > console

To run the benchmarks, drop into the benchmark subproject using the project command, and run:

curve > project benchmarks
benchmarks > run

About

SFCurve is a Scala library for the creation, transformation, and querying of space-filling curves

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Scala 78.5%
  • Shell 21.5%