From 2e7e4f33961dba40fc6c910f14283078d56104a6 Mon Sep 17 00:00:00 2001 From: ovainola Date: Sun, 5 Jul 2015 10:31:57 +0300 Subject: [PATCH 1/5] Delete README.md Checking whether github automatically changes to README.rst --- README.md | 46 ---------------------------------------------- 1 file changed, 46 deletions(-) delete mode 100644 README.md diff --git a/README.md b/README.md deleted file mode 100644 index 7c1fa82..0000000 --- a/README.md +++ /dev/null @@ -1,46 +0,0 @@ -![JuliaFEMLogo](https://github.com/JuliaFEM/JuliaFEM.jl/blob/master/docs/logo/JuliaFEMLogo_256x256.png) -# JuliaFEM - -[![Join the chat at https://gitter.im/JuliaFEM/JuliaFEM](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/JuliaFEM/JuliaFEM?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) - -Build Status: [![Build Status](https://travis-ci.org/JuliaFEM/JuliaFEM.jl.svg?branch=master)](https://travis-ci.org/JuliaFEM/JuliaFEM.jl) - -Code Coverage: [![Coverage Status](http://coveralls.io/repos/JuliaFEM/JuliaFEM.jl/badge.svg?branch=master)](https://coveralls.io/r/JuliaFEM/JuliaFEM.jl?branch=master) - -Documentation: http://www.juliaFEM.org - -The JuliaFEM project develops open-source software for reliable, scalable, distributed Finite Element Method. - -The JuliaFEM software library is a framework that allows for the distributed processing of large Finite Element Models across clusters of computers using simple programming models. It is designed to scale up from single servers to thousands of machines, each offering local computation and storage. The basic design principle is: everything is nonlinear. All physics models are nonlinear from which the linearization are made as a special cases. - -JuliaFEM current status: project planning - -Initial road map for JuliaFEM: - -+---------+-----------------------------+-----------------+ -| version | number of degree of freedom | number of cores | -+=========+=============================+=================+ -| 1.0 | 100 000 000 | 1 000 | -+---------+-----------------------------+-----------------+ -| 2.0 | 1 000 000 000 | 10 000 | -+---------+-----------------------------+-----------------+ -| 3.0 | 10 000 000 000 | 100 000 | -+---------+-----------------------------+-----------------+ - -We strongly believe in the test driven development as well as building on top of previous work. Thus all the new code in this project should be 100% tested. Also other people have wisdom in style as well: - -[The Zen of Python](https://www.python.org/dev/peps/pep-0020/) -``` - Beautiful is better than ugly. - Explicit is better than implicit. - Simple is better than complex. - Complex is better than complicated. - Flat is better than nested. - Sparse is better than dense. - Readability counts. - Errors should never pass silently. -``` - -Interested in participating? Please start by reading [CONTRIBUTING.md](https://github.com/JuliaFEM/JuliaFEM/blob/master/CONTRIBUTING.md). - -Contributors: see [contributors](https://github.com/JuliaFEM/JuliaFEM/blob/master/contributors) From 5fd5f0abcb0fd955099e525977fedf8ec6c8c242 Mon Sep 17 00:00:00 2001 From: ovainola Date: Sun, 5 Jul 2015 10:33:18 +0300 Subject: [PATCH 2/5] Update README.rst --- README.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.rst b/README.rst index 36c8878..f009208 100644 --- a/README.rst +++ b/README.rst @@ -1,3 +1,6 @@ + +.. image:: https://github.com/JuliaFEM/JuliaFEM.jl/blob/master/docs/logo/JuliaFEMLogo_256x256.png + ======== JuliaFEM ======== From 60cc549fd0a151c4c206247effc3aae90b7b16fc Mon Sep 17 00:00:00 2001 From: ovainola Date: Sun, 5 Jul 2015 11:22:28 +0300 Subject: [PATCH 3/5] Added search_modules! function --- docs/build_api.jl | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/docs/build_api.jl b/docs/build_api.jl index 8b5ef39..328922a 100644 --- a/docs/build_api.jl +++ b/docs/build_api.jl @@ -1,7 +1,41 @@ using Docile, Lexicon, JuliaFEM const api_directory = "api" -const modules = [JuliaFEM, JuliaFEM.elasticity_solver] + +""" +Searches recursively all the modules from packages. As documentation grows, it's a bit +troublesome to add all the new modules manually, so we've written with this function +which searches all the modules automatically. + +Parameters +---------- + module_: Module + Module where we want to search modules inside + append_list: Array{Module, 1} + Array, where we append Modules as we find them + +Returns +------- + None. Void function, which manipulates the append_list +""" +function search_modules!(module_::Module, append_list::Array{Module, 1}) + if module_parent(module_) == Main + push!(append_list, module_) + end + all_names = names(module_, true) + for each in all_names + inner_module = module_.(each) + if (typeof(inner_module) == Module) && !(inner_module in append_list) + push!(append_list, inner_module) + search_modules!(inner_module, append_list) + end + end +end + +append_list = [] +search_modules!(JuliaFEM, append_list) + +const modules = append_list # main_folder = dirname(dirname(@__FILE__)) # this_folder = dirname(@__FILE__) From 6ac5efaa70a63001c11b63ca81ede1110d28730f Mon Sep 17 00:00:00 2001 From: ovainola Date: Sun, 5 Jul 2015 11:24:01 +0300 Subject: [PATCH 4/5] Update build_api.jl --- docs/build_api.jl | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/build_api.jl b/docs/build_api.jl index 328922a..a28ff67 100644 --- a/docs/build_api.jl +++ b/docs/build_api.jl @@ -19,9 +19,6 @@ Returns None. Void function, which manipulates the append_list """ function search_modules!(module_::Module, append_list::Array{Module, 1}) - if module_parent(module_) == Main - push!(append_list, module_) - end all_names = names(module_, true) for each in all_names inner_module = module_.(each) From 9820f28fe456942e399bc536716809dd14310239 Mon Sep 17 00:00:00 2001 From: ovainola Date: Sun, 5 Jul 2015 11:26:26 +0300 Subject: [PATCH 5/5] Update build_api.jl --- docs/build_api.jl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/build_api.jl b/docs/build_api.jl index a28ff67..3b8344f 100644 --- a/docs/build_api.jl +++ b/docs/build_api.jl @@ -4,8 +4,8 @@ const api_directory = "api" """ Searches recursively all the modules from packages. As documentation grows, it's a bit -troublesome to add all the new modules manually, so we've written with this function -which searches all the modules automatically. +troublesome to add all the new modules manually, so this function searches all the modules +automatically. Parameters ----------