Skip to content

Commit

Permalink
Upgraded Maven plugins
Browse files Browse the repository at this point in the history
  • Loading branch information
Peter Dekkers committed Aug 26, 2022
1 parent 26ce133 commit 26083d1
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 15 deletions.
6 changes: 4 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -104,15 +104,17 @@ Some key features of roboquant are:
See also https://roboquant.org/background/features.html[Features] for a more extensive feature list and how roboquant compares to some other platforms.

== License
Roboquant is distributed under the link:/LICENSE[Apache 2.0 License].
Roboquant is distributed under the link:/LICENSE[Apache 2.0 License]. The Apache 2.0 license is a permissive license, meaning there are few restrictions on the use of the code.

== Thanks

Besides all the link:docs/THIRDPARTY.adoc[great open source software] that is powering _roboquant_, also special thanks to JetBrains for making a https://www.jetbrains.com/community/opensource/[license] available of *IntelliJ IDEA*.

image:https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png[JetBrains,100,100]


== Disclaimer
_Roboquant_ also comes with live trading and paper trading capabilities. Using this is at your own risk and there are NO guarantees about the correct functioning of the software.
_Roboquant_ also comes with live trading and paper trading capabilities. Using this is at your own risk and there are *NO GUARANTEES* about the correct functioning of the software.

== Beta version
_Roboquant_ is still a pre-1.0 release and bugs are for sure to be expected. Also expect APIs to change without any notice. So keep this in mind when using it.
Expand Down
2 changes: 1 addition & 1 deletion docs/THIRDPARTY.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= 3rd Party

Roboquant couldn't have been developed without the use of free and open source third party software. This document list some of the great open software libraries and other artefacts used in roboquant.
_Roboquant_ couldn't have been developed without the use of free and open source third party software. This document list some of the great open software libraries and other artefacts used in roboquant.

== Software
* https://kotlinlang.org[Kotlin]: modern, concise and safe programming language that makes writing code a joy.
Expand Down
14 changes: 7 additions & 7 deletions docs/TODO.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,21 +27,20 @@ Version 0.8 is all about making sure that (back-)testing works, and the most com

Ensure the API is stable and start including AI and Machine Learning support

* [X] Stabilize the exposed API (perhaps also enable -Xexplicit-api=strict compiler flag)
* [ ] Improve documentation, notebooks and examples based on the stable API
* [ ] Include additional demo feeds for quick experimentation (some forex and crypto assets)
* [ ] Add basic Machine Learning support (research required)
* [ ] Add better hyperparameter search and optimization capabilities (research required)
* [X] Stabilize the exposed API
* [X] Improve documentation, notebooks and examples based on the stable API
* [X] Include additional demo feeds for quick experimentation
* [X] Use better approach for generating charts

== Version 1.0.x (end of 2022)

This version is all about adding better trading capabilities. Although there is already integration available in earlier versions, that is just to validate the architectural concepts supports live trading. These broker integrations are neither reliable nor complete. So what still needs to be done:

* [ ] Better margin account simulation support
* [ ] More metrics, especially around alpha and beta calculations
* [ ] Add more advanced slippage- and fee-models
* [ ] Add visualizations for the tuning of strategies (research required)
* [ ] Add support for distributed back-testing (research required)
* [ ] Add basic Machine Learning support (research required)
* [ ] Add better hyperparameter search and optimization capabilities (research required)

== Version 2 and later (2023 and beyond)

Expand All @@ -51,6 +50,7 @@ The topics mentioned here are some of the ideas for the future releases:
* [ ] Better and more complete integrations with brokers and crypto-exchanges
* [ ] Advanced policies, like auto re-balancing portfolios
* [ ] More ready-to-use strategies out of the box
* [ ] Add more advanced slippage- and fee-models
* [ ] More complex deep learning strategies
* [ ] Right now messages and formats support English format only, add L10N/I18N support
* [ ] Make video(s) that show the steps to develop and test your own strategies
Expand Down
10 changes: 5 additions & 5 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-failsafe-plugin</artifactId>
<version>3.0.0-M6</version>
<version>3.0.0-M7</version>
<executions>
<execution>
<goals>
Expand All @@ -238,7 +238,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>3.2.0</version>
<version>3.3.0</version>
<configuration>
<propertiesEncoding>ISO-8859-1</propertiesEncoding>
</configuration>
Expand All @@ -247,7 +247,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-deploy-plugin</artifactId>
<version>3.0.0-M1</version>
<version>3.0.0</version>
</plugin>

<plugin>
Expand All @@ -259,7 +259,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>3.0.0-M6</version>
<version>3.0.0-M7</version>
<configuration>
<consoleOutputReporter implementation="org.apache.maven.plugin.surefire.extensions.junit5.JUnit5ConsoleOutputReporter" />
</configuration>
Expand Down Expand Up @@ -289,7 +289,7 @@
<plugin>
<groupId>com.github.ozsie</groupId>
<artifactId>detekt-maven-plugin</artifactId>
<version>1.20.0</version>
<version>1.21.0</version>
<configuration>
<config>docs/run/detekt.yaml</config>
</configuration>
Expand Down

0 comments on commit 26083d1

Please sign in to comment.