Merge pull request #5 from ClapeyronThermo/vini/docs

Vini/docs
ClapeyronThermo · Aug 5, 2024 · 4047c4d · 4047c4d
2 parents 817e8fb + 25fe21e
commit 4047c4d
Show file tree

Hide file tree

Showing 40 changed files with 2,304 additions and 175 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
 /Manifest.toml
+Manifest.toml
diff --git a/Project.toml b/Project.toml
@@ -4,32 +4,30 @@ authors = ["Andrés Riedemann <[email protected]> and contributors"]
 version = "1.0.0"
 
 [deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
+Integrals = "de52edbc-65ea-441a-8357-d3a637375a31"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 LogExpFunctions = "2ab3a3ac-af41-5b50-aa03-7779005ae688"
 NLSolvers = "337daf1e-9722-11e9-073e-8b9effe078ba"
+PolyLog = "85e3b03c-9856-11eb-0374-4dc1f8670e7f"
+Revise = "295af30f-e4ad-537b-8983-00126c2a3abe"
 Roots = "f2b01f46-fcfa-551c-844a-d8ac1e96c665"
+StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"
 
-[weakdeps]
-Clapeyron = "7c7805af-46cc-48c9-995b-ed0ed2dc909a"
-
-[extensions]
-IASTClapeyronExt = "Clapeyron"
-
 [compat]
-Clapeyron = "0.5,0.6"
 ForwardDiff = "^0.10"
-julia = "1.9"
 LinearAlgebra = "1"
 LogExpFunctions = "^0.3.24"
 NLSolvers = "0.5"
+PolyLog = "2.5.0"
 Roots = "2.1"
 Tables = "^1.8"
+julia = "1.9"
 
 [extras]
-Clapeyron = "7c7805af-46cc-48c9-995b-ed0ed2dc909a"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Test", "Clapeyron"]
+test = ["Test"]
diff --git a/README.md b/README.md
@@ -2,6 +2,10 @@
 
 [![Build Status](https://github.com/longemen3000/AdsorbedSolutionTheory.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/longemen3000/AdsorbedSolutionTheory.jl/actions/workflows/CI.yml?query=branch%3Amain)
 
-Package for calculation of Ideal Absorbed Solution Theory.
+
+This package implements single adsorption and multicomponent adsorption through Ideal Absorbed Solution Theory (IAST). Some major features are:
+
+    - Explicit single component adsorption properties: loading, bulk phase properties
+    - Multicomponent adsorption 
 
 #
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -0,0 +1,3 @@
+[deps]
+AdsorbedSolutionTheory = "c62cc850-d7ca-4cc1-a95b-48008b40dc90"
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
diff --git a/docs/build/.documenter-siteinfo.json b/docs/build/.documenter-siteinfo.json
@@ -0,0 +1 @@
+{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-08-04T22:46:04","documenter_version":"1.5.0"}}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-08-04T22:46:04","documenter_version":"1.5.0"}}