Skip to content

Fix links#1141

Merged
Datseris merged 11 commits into
JuliaDynamics:mainfrom
jmaspons:fix_links
Feb 28, 2025
Merged

Fix links#1141
Datseris merged 11 commits into
JuliaDynamics:mainfrom
jmaspons:fix_links

Conversation

@jmaspons
Copy link
Copy Markdown
Contributor

Fix #1140

Fix the following broken links in the gh-pages branch:

S'han trobat 39 coincidències (39 marcades) a la carpeta ./Agents.jl/dev/
api/index.html: 28
  2:8508: ructures <a href="#Agents.AgentBasedModel"><code>AgentBasedModel</code></a>, <a href="@ref Space">Space</a>, <a href="#Agents.AbstractAgent"><code>AbstractAgent</code></a> which are describe
  2:10331: ightforward to create your own versions of <code>AgentBasedModel</code>, see <a href="@ref make_new_model">the corresponding entry in the developer documentation</a>.</p><p><strong>Interface
  2:11120:  model. All models start from time 0 and time is incremented as the model is <a href="@ref"><code>step!</code></a>-ped.</li><li><code>abmrng(model)</code> will return the random number gener
  2:14512: es.</p><p><code>space</code> is a subtype of <code>AbstractSpace</code>, see <a href="@ref Space">Space</a> for all available spaces. If it is omitted then all agents are virtually in one po
 20:4686: es.</p><p><code>space</code> is a subtype of <code>AbstractSpace</code>, see <a href="@ref Space">Space</a> for all available spaces.</p><p><code>events</code> is a container of instances of
 20:6453: s="admonition-body"><p>This model does not yet support IO operations such as <a href="@ref"><code>save_checkpoint</code></a>. Pull Requests that implement this are welcomed!</p></div></div><
 20:7352: ensity, kinds, timing)</code></pre><p>An event instance that can be given to <a href="@ref"><code>EventQeueABM</code></a>.</p><ul><li><code>action! = dummystep</code>: is the function <code>
 73:1317: nts types.</p><p>See the <a href="../tutorial/#Tutorial">Tutorial</a> or the <a href="@ref multiagent_vs_union">performance comparison versus <code>Union</code> types</a> for why it is often
 89:1194: ng> the <code>id::Int</code> field as first field. If any space is used (see <a href="@ref">Available spaces</a>), a <code>pos</code> field of appropriate type is also mandatory. The core mo
 89:6777: t &lt;: AbstractAgent</code></pre><p>The minimal agent struct for usage with <a href="@ref"><code>OpenStreetMapSpace</code></a>. It has an additional field <code>pos::Tuple{Int,Int,Float64}<
 92:5902: quot; from Agents.jl. To create your own, see the developer documentation on <a href="@ref make_new_space">creating a new space type</a>.</p><h3 id="Discrete-spaces"><a class="docs-heading-a
 92:10343: code>i</code>-th dimension.</p><p>An example using <code>GridSpace</code> is <a href="@ref">Schelling&#39;s segregation model</a>.</p><p><strong>Distance specification</strong></p><p>The typ
 92:17263:  properties in conjunction with <code>ContinuousSpace</code>.</p><p>See also <a href="@ref">Continuous space exclusives</a> on the online docs for more functionality. An example using contin
 95:684: s an agent can truly be at any possible point on an existing road.</p><p>Use <a href="@ref"><code>OSMAgent</code></a> for convenience.</p><p><strong>Obtaining map files</strong></p><p>Maps f
122:2502: /a>/<a href="#Agents.ContinuousSpace"><code>ContinuousSpace</code></a> using <a href="@ref"><code>Pathfinding.Pathfinder</code></a>, a special movement method is available.</p><article class
124:5986: del::ABM)</code></pre><p>Return the size of the model&#39;s space. Works for <a href="@ref"><code>AbstractGridSpace</code></a> and <a href="#Agents.ContinuousSpace"><code>ContinuousSpace</co
125:1220: ition</code></a>, but specialized for <code>GridSpaceSingle</code>. See also <a href="@ref"><code>isempty</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github
129:17561: ode>:exact</code> or <code>:approximate</code>.</li></ul><p>Example usage in <a href="@ref">https://juliadynamics.github.io/AgentsExampleZoo.jl/dev/examples/growing_bacteria/</a>.</p><div cl
131:4332:  map requires <code>network_type = :none</code> to be passed as a keyword to <a href="@ref"><code>OSMSpace</code></a>. The unit of distance used for this map is <code>:time</code>.</p></div>
154:1258: ABM, t::Union{Real, Function}; kwargs...)</code></pre><p>Run the model (call <a href="@ref"><code>step!</code></a><code>(model, t)</code> and collect data specified by the keywords, explaine
154:9247: ;s initial random seed and/or agent distribution.</p><p>See example usage in <a href="@ref">Schelling&#39;s segregation model</a>.</p><p><strong>Keywords</strong></p><p>The following keyword
154:14364: trong></p><p>A runnable example that uses <code>paramscan</code> is shown in <a href="@ref">Schelling&#39;s segregation model</a>. There, we define</p><pre><code class="language-julia hljs">
187:1598: will return the scheduled IDs.</li><li>Can be used by a user when performing <a href="@ref manual_scheduling">manual scheduling</a> in case <code>agent_step!</code> has not been configured.<
187:8493: _union</code> is a <code>Union</code> of all valid agent types (as passed to <a href="@ref"><code>ABM</code></a>)</li></ul><pre><code class="nohighlight hljs">Schedulers.ByType((C, B, A), sh
202:570:  define your fundamental types at all processors. How to do this is shown in <a href="@ref">Ensembles and distributed computing</a> section of Schelling&#39;s Segregation Model example. See 
202:2833: ithub.io/AgentsExampleZoo.jl/dev/examples/runners/">Mountain Runners</a> and <a href="@ref">Rabbit, Fox, Hawk</a> examples using path-finding and see the available functions below as well.</
202:5238: </li></ul><p>Utilization of all features of <code>AStar</code> occurs in the <a href="@ref">3D Mixed-Agent Ecosystem with Pathfinding</a> example.</p></div><a class="docs-sourcelink" target=
223:1189: n!(model, t::Union{Real, Function}; kwargs...)</code></pre><p>Do the same as <a href="@ref"><code>run</code></a>, but instead of collecting all the data into an in-memory dataframe, write th
devdocs/index.html: 2
  2:9424: ocs-heading-anchor" href="#[Creating-a-new-model-type](@ref-make_new_model)"><a href="@ref make_new_model">Creating a new model type</a></a><a id="[Creating-a-new-model-type](@ref-make_new_m
  2:11268: ocs-heading-anchor" href="#[Creating-a-new-space-type](@ref-make_new_space)"><a href="@ref make_new_space">Creating a new space type</a></a><a id="[Creating-a-new-space-type](@ref-make_new_s
examples/event_rock_paper_scissors/index.html: 1
 72:393: ink" href="#Time-evolution" title="Permalink"></a></h2><p>Time evolution for <a href="@ref"><code>EventBasedABM</code></a> is identical to that of <a href="../../api/#Agents.StandardABM"><co
examples/measurements/index.html: 3
  2:7216:  with much of the Julia ecosystem.</p><p>Here, we&#39;ll slightly modify the <a href="@ref">Daisyworld</a> example, to simulate some measurement uncertainty in our world&#39;s parameters.</p
 13:721: for DaisyWorld. If you want to know what each of these functions do, see the <a href="@ref">Daisyworld</a> example, as they are copied directly from there.</p><pre><code class="language-juli
129:782:  href="#Visualizing-the-Result" title="Permalink"></a></h2><p>Similar to the <a href="@ref">Daisyworld</a> example, we will now check out how the surface temperature and daisy count fares wh
examples/predator_prey/index.html: 1
  4:2965: lly that much of an advantage to have two different agent types. Like in the <a href="@ref">Rabbit, Fox, Hawk</a> example, we could have only one type and one additional field to separate th
index.html: 1
 18:2535: planet, or whatever else) by only extending 5 functions, as discussed in our <a href="@ref">Creating a new space type</a> documentation. Indeed, the simplicity of Agents.jl is due to the int
performance_tips/index.html: 2
 40:1330: d increase in performance.</p><p>For an example of how this is done, see the <a href="@ref">Forest fire</a> model, which is a cellular automaton that has no agents in it, or the <a href="@re
 40:1431: re</a> model, which is a cellular automaton that has no agents in it, or the <a href="@ref">Daisyworld</a> model, which has both agents as well as a spatial property represented by an <code>
tutorial/index.html: 1
197:453:  evolve it forwards in time. This step is rather trivial. We simply call the <a href="@ref"><code>step!</code></a> function on the model</p><pre><code class="language-julia hljs">step!(schel

TODO:

  • 125:1220: ition</code></a>, but specialized for <code>GridSpaceSingle</code>. See also <a href="@ref"><code>isempty</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github Missing docstring for isempty(::Integer, ::ABM). Check Documenter's build log for details.

  • 124:5986: del::ABM)</code></pre><p>Return the size of the model&#39;s space. Works for <a href="@ref"><code>AbstractGridSpace</code></a> and <a href="#Agents.ContinuousSpace"><code>ContinuousSpace</co Missing docstring. Add abstract classes to API docs?

  • Missing docstring for schedule. Check Documenter's build log for details.

  • Backport?

Review

  • 202:570: define your fundamental types at all processors. How to do this is shown in <a href="@ref">Ensembles and distributed computing</a> section of Schelling&#39;s Segregation Model example. NOT ANYMORE 98c5fd2
  • Not sure if this is the proper fix for docs in submodules 46329ba

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Feb 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.00%. Comparing base (8b5b456) to head (8add7a6).
Report is 176 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #1141       +/-   ##
===========================================
+ Coverage   70.12%   85.00%   +14.87%     
===========================================
  Files          42       37        -5     
  Lines        2718     2534      -184     
===========================================
+ Hits         1906     2154      +248     
+ Misses        812      380      -432     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Copy Markdown
Member

@Datseris Datseris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, this is fantastic and very helkpful!

Comment thread docs/src/api.md Outdated
Comment thread src/submodules/pathfinding/astar.jl Outdated
Comment thread docs/src/api.md Outdated
Copy link
Copy Markdown
Member

@Datseris Datseris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you this is very helpful!

@Datseris Datseris merged commit 0479c38 into JuliaDynamics:main Feb 28, 2025
@jmaspons jmaspons deleted the fix_links branch February 28, 2025 15:23
@jmaspons
Copy link
Copy Markdown
Contributor Author

There are still some TODOs. I'll do a grep with the new docs in gh-pages

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Broken links in docs

3 participants