From 00cd40ab10ef2fd90c1eafead3a3026f1d592180 Mon Sep 17 00:00:00 2001 From: Nicholas Harrison Date: Wed, 6 Nov 2024 20:40:43 -0700 Subject: [PATCH] docs: update readme intro --- app/Manifest.toml | 2 +- app/Project.toml | 3 +++ core/Manifest.toml | 2 +- core/Project.toml | 9 +++++++-- docs/Manifest.toml | 2 +- docs/Project.toml | 4 ++++ docs/make.jl | 9 +++++++-- readme.org | 12 ++++-------- utils/Manifest.toml | 2 +- utils/Project.toml | 2 +- 10 files changed, 30 insertions(+), 17 deletions(-) diff --git a/app/Manifest.toml b/app/Manifest.toml index 05aa4ea..72c7ee1 100644 --- a/app/Manifest.toml +++ b/app/Manifest.toml @@ -2,7 +2,7 @@ julia_version = "1.10.2" manifest_format = "2.0" -project_hash = "cd36817b8538fc312da91b5b162a3a353cac0667" +project_hash = "beba688800eb88807105e3e6656a2c23b0642ab4" [[deps.AbstractFFTs]] deps = ["LinearAlgebra"] diff --git a/app/Project.toml b/app/Project.toml index 86e5f99..d91b7c0 100644 --- a/app/Project.toml +++ b/app/Project.toml @@ -20,3 +20,6 @@ RobotOS = "22415677-39a4-5241-a37a-00beabbbdae8" Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2" StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91" YAML = "ddb6d928-2868-570f-bddf-ab3f9cf99eb6" + +[compat] +julia = "1.10" diff --git a/core/Manifest.toml b/core/Manifest.toml index 8934dbf..ec57a22 100644 --- a/core/Manifest.toml +++ b/core/Manifest.toml @@ -2,7 +2,7 @@ julia_version = "1.10.2" manifest_format = "2.0" -project_hash = "758601bb8456cc690f0d7b683e23b43f6a69e408" +project_hash = "6900ff5779df6772d57684bb92c77ff72c5f472d" [[deps.AbstractGPs]] deps = ["ChainRulesCore", "Distributions", "FillArrays", "IrrationalConstants", "KernelFunctions", "LinearAlgebra", "PDMats", "Random", "RecipesBase", "Reexport", "Statistics", "StatsBase", "Test"] diff --git a/core/Project.toml b/core/Project.toml index fc24fa4..131edf1 100644 --- a/core/Project.toml +++ b/core/Project.toml @@ -12,10 +12,15 @@ LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e" Optim = "429524aa-4258-5aef-a3af-852621145aeb" ParameterHandling = "2412ca09-6db7-441c-8e3a-88d5709968c5" Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f" -PyCall = "438e738f-606a-5dbb-bf0a-cddfbfd45ab0" Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c" Rotations = "6038ab10-8711-5258-84ad-4b1120ba62dc" Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2" +[weakdeps] +PyCall = "438e738f-606a-5dbb-bf0a-cddfbfd45ab0" + +[extensions] +ROSInterface = "PyCall" + [compat] -julia = ">= 1.9" +julia = "1.10" diff --git a/docs/Manifest.toml b/docs/Manifest.toml index d725da5..04ed65d 100644 --- a/docs/Manifest.toml +++ b/docs/Manifest.toml @@ -2,7 +2,7 @@ julia_version = "1.10.2" manifest_format = "2.0" -project_hash = "aa51543ac8436e6e88020ded35ef6ec1e89249e9" +project_hash = "25d1a1d57998e7598cd36425565319cd4fc45239" [[deps.ANSIColoredPrinters]] git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c" diff --git a/docs/Project.toml b/docs/Project.toml index 04a94f0..b25b42d 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -2,3 +2,7 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" InformativeSampling = "bfd01cc8-db36-4de5-b056-8ab04eef9441" InformativeSamplingUtils = "1d6b69be-e25c-46ac-b1c5-442f720809e4" + +[compat] +julia = "1.10" +Documenter = "1.5" diff --git a/docs/make.jl b/docs/make.jl index fd7cdf4..6d5d333 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -7,8 +7,8 @@ using InformativeSampling: Maps, Missions, BeliefModels, Kernels, using InformativeSamplingUtils: DataIO, Visualization, Metrics makedocs( - sitename="InformativeSampling.jl", - remotes=nothing, + sitename="InformativeSampling", + # remotes=nothing, pages = [ "index.md", "application.md", @@ -19,3 +19,8 @@ makedocs( ], format = Documenter.HTML(prettyurls=false) ) + +deploydocs( + repo = "github.com/ngharrison/InformativeSampling.git", + versions = nothing, +) diff --git a/readme.org b/readme.org index 315f063..0dd64b0 100644 --- a/readme.org +++ b/readme.org @@ -1,14 +1,8 @@ #+title: Informative Sampling -A repository for robotic exploration in natural environments. +This code was written as part of my PhD research in field robotics, specifically for robotic informative sampling in natural environments. The code is written in Julia for speed and code flexibility. -Main focus on robotic information gathering on a 2D surface. - -This code was written for PhD research in field robotics. - -Written in Julia for speed and code flexibility. - -Created by Nicholas Harrison. +The purpose of this repository is mainly to serve as a reference implementation for the methods in my thesis (link will be included once published). However, the code is organized and documented to be usable by others for their own applications. If you have questions about the code or problems trying to use it, feel free to post in the Discussions or Issues, and I'll see how I can help. Also important to know, I am currently in the process of improving the organization, so things are not guaranteed to be very stable just yet. See a video of an example run [[file:docs/res/ICRA_2024_run.mp4][here]]. @@ -147,6 +141,8 @@ Note that just the same as when running Julia code normally, if the interpreter * Documentation +The docs can be viewed at https://ngharrison.github.io/InformativeSampling. + If you want to view the docs locally, first generate them by running the following command(s) from the project root: #+begin_src shell diff --git a/utils/Manifest.toml b/utils/Manifest.toml index 9e2b651..b849362 100644 --- a/utils/Manifest.toml +++ b/utils/Manifest.toml @@ -2,7 +2,7 @@ julia_version = "1.10.2" manifest_format = "2.0" -project_hash = "2f3d2b14f2dd149f452899fadc3387062e44ea71" +project_hash = "f94307accf23328b8d4e5ef5983a31ec58f0c1a7" [[deps.AbstractFFTs]] deps = ["LinearAlgebra"] diff --git a/utils/Project.toml b/utils/Project.toml index 9485d14..19a11e4 100644 --- a/utils/Project.toml +++ b/utils/Project.toml @@ -15,4 +15,4 @@ Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80" Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2" [compat] -julia = ">= 1.9" +julia = "1.10"