<commit_before># Mortgage

[![Build Status](https://travis-ci.org/holder66/Mortgage.jl.svg?branch=master)](https://travis-ci.org/holder66/Mortgage.jl)<commit_msg>stuff copied from Hecke.jl readme<commit_after># Mortgage

[![Build Status](https://travis-ci.org/holder66/Mortgage.jl.svg?branch=master)](https://travis-ci.org/holder66/Mortgage.jl)

## About

Mortgage is a software package for loan and mortgage calculations, maintained by <NAME>.
It is written in [julia](http://www.julialang.org).

- [https://github.com/thofma/Hecke.jl](https://github.com/thofma/Hecke.jl) (Source code)
- [http://hecke.readthedocs.org/en/latest/](http://hecke.readthedocs.org/en/latest/) (Online documentation)

So far, Mortgage provides the following features:

  - Works in any decimal-based currency
  - Generates a summary printout
  - Can generate a table of payments

## Installation

To use Mortgage, a julia version of 0.4 or higher is necessary (the latest stable julia version will do).
Please see [http://julialang.org/downloads](http://julialang.org/downloads/) for instructions on how to obtain julia for your system.
Once a suitable julia version is installed, use the following steps at the julia prompt to install Mortgage:

```julia
julia> Pkg.clone("https://github.com/holder66/Mortgage.jl")
julia> Pkg.build("Mortgage")
```

## Quick start

Here is a quick example of using Mortgage:

```julia
julia> using Mortgage
...

julia> mortgage()
```

## Documentation

The online documentation can be found here: [http://hecke.readthedocs.org/en/latest/]

The documentation of the single functions can also be accessed at the julia prompt. Here is an example:

```
help?> signature
search: signature

  ----------------------------------------------------------------------------

  signature(O::NfMaximalOrder) -> Tuple{Int, Int}

  |  Returns the signature of the ambient number field of \mathcal O.
```
{'fraction_non_alphanumeric': 0.16254602840610205, 'fraction_numerical': 0.00631246712256707, 'mean_word_length': 3.696296296296296, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 10, 'https://': 7, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1389795', 'n_tokens_mistral': 623, 'n_tokens_neox': 585, 'n_words': 175}